Linus Torvalds o způsobech zápisu komentářů ve zdrojových kódech Linuxu

Vkládat komentáře do zdrojových kódů programů psaných v programovacím jazyce C lze několika způsoby. Překladači jazyka C je jedno, který ze způsobů je použit. Kolega nebo kolegyně v týmu může mít ale s některými způsoby zápisu komentářů problém. Jaké způsoby zápisu komentářů [reddit] ve zdrojových kódech Linuxu doporučuje Linus Torvalds?

11.7.2016 18:05 | Ladislav Hagara | Komunita

Komentáře

[pc2005]

Tak některý z nich dělám taky (ve vývojových verzích) .

Ale třeba boxing se hodí v lilo.conf, snižuje mi to riziko toho, že si rozbiju konfiguraci bootloaderu.

[Okoun]

To je arogantní vůl, to snad není pravda :)

[pavlix]

Ale především má pravdu. :)

[rastos]

To nasere najviac

[Michal Kubeček]

I really don't understand why the networking people think that their particularly ugly styles are fine. They are the most visually unbalanced version of _all_ the common comment styles, and have no actual advantages.

To je zrovna dost očividné z některých jiných specifik síťového stacku. Zatímco Linus ujíždí na vizuální vyváženosti a estetice, David Miller na ušetřených řádcích.

[pc2005]

Njn nejspíš začínal v 80x25 editorech, tam je každá viditelná řádka dobrá.

[lertimir]

Mě fascinuje jeho dramatický rozdíl mezi stylem d) a (no-no-no).

[little.owl]

Podle me Linus zase ustrelil. Estetika je subjektivni, a at se vybere cokoliv je dobre byt konzistentni.

[pavlix]

Vždyť žádal právě jen dodržování konzistentního stylu a to ještě dost benevolentně, s několika variantami. A navíc si myslím, že to docela trefil a nejen esteticky, ale i kvůli přehlednosti.

[little.owl]

On hlavne hulvatsky sejmu styl, ktery nema rad, aniz by predlozil presvedcive duvody.

[chrono]

To si mal dať vypracovať nejakú odbornú štúdiu?

[pc2005]

Tak mu to napiš, do té doby je jen benevolentní diktátor .

(a) je default, (c) je default, (b) snad generujou automaticky některý editory, navíc můžeš smazat řádek bez zničení otevírací nebo uzavírající sekvence. U (d) by teotericky mohl nastat problém s odsazením + komplikovaně se mažou řádky. (no) má nejspíš rozbité odsazovaní a (no-no-no) má jen hvězdičku navíc u nedoporučováného (d).

Ty hvězdičky fungujou jako vodící linka souvislého bloku (git diff, email klient ti nemusí vybarvovat komentáře), co není kód a když to jsou ty /* a */ na samostatných řádcích, tak to vypadá prostě tak nějak lépe.

[chrono]

On ale reagoval na to, že bola nejaká záplata odmietnutá len preto, že nepoužívala ten (podľa Linusa) škaredý štýl komentárov.

[Salamek]

Tak podle me ma pravdu, ja osobne styly (no) a (no-no-no) povazuji za ~rozbite komentare a automaticky je opravuji na (b) nebo (c) v pripade single line (No presneji cely zdrojak prozenu pres astyle)

[kralyk z abclinuxu]

A není to jedno? Linus někomu v mailu napíše názor na komentáře a celý internet to rozmázne a sáhodlouze o tom diskutuje...

[martin]

mozna kdyby v tom nazoru nepouzival slovni vyrazy jako "half-arsed shit-for-brains", tak by o tom nikdo sahodlouze nediskutoval. on v tom mozna bude nejaky skryty umysl ;)

jinak jo, je to jedno

[Bill Gates]

Cely internet? Opravdu ? :D

[kralyk z abclinuxu]

Ano, četl jsem o tom na iDnesu. Lidé tam komentovali, že být šéfem kernelu, určitě by to vyřešili lépe. Na novinkách zase komentovali, že za minulého režimu takový bordel v komentářích rozhodně nebyl.

[andrej]

> za minulého režimu takový bordel v komentářích rozhodně nebyl

:D :D :D

[little.owl]

Denik Daily Telegraph si vsima vlivu komentaru v Linux na burzovni index FSTE londynske burzy bezici na Linuxu a predpovida zanik Eura. Denik The Guardian vyjadruje obavu, aby pripadna zmena stylu komentaru nemela neprimerene dopady na chude a bezmocne. Podle Daily Mail za to mohou imigranti z vychodni Evropy a zduraznuje, ze odchodem z EU Britanie opet prevezme kontrolu nad svymi komentari.

[Michal Kubeček]

Abychom se vrátili do našich luhů a hájů… Hospodářské noviny uveřejňují sáhodlouhý rozbor, ze kterého je sice každému programátorovi zřejmé, že autor nikdy neprogramoval a netuší, co je céčko, ale na všechny ostatní udělá dojem, jak je intelektuálně na výši a jaký má rozhled. Na Novinkách se Václav Klaus mladší nechává slyšet, že jednotný formát komentářů je učebnicový příklad zvůle bruselských úředníků a nepřípustný zásah do svobody jednotlivce. Tamtéž pak Alexandr Mitrofanov nalézá alarmující paralely mezi chováním Linuse Torvaldse a Miloše Zemana, načež si pokládá otázku, zda prvně jmenovaný také nebude Putinova loutka.

[R]

Dufam, ze nepovolia C++ // komentare. Pouzivam ich pri testovani a vyvoji na oznacenie nedokoncenych veci. Checkpatch mi ich potom pripomenie pri vytvarani finalnej verzie patchu.

[pc2005]

(c) + už teď jich je v kernelu hodně.

[Michal Kubeček]

A co jim takhle říkat "C99 komentáře"?

[prohnuta nudle]

+1

[Ivan2]

Ne tohle pouzivam "#if 0" anebo "#if defined(EXPERIMENTAL)", Ma to vyhodu, ze se to snadno najde a navic to nerozbije formatovani (a taky se to da zapouzdrovat do sebe).

[pet I.]

Ale na druhou stranu to má zase tu nevýhodu, že to není obarveno zvýrazněním syntaxe, tak to lze snadno přehlédnout.

[Sten]

To záleží na IDE. Třeba KDevelop blok v #if 0 obarvuje jako komentář.

[Atom321]

No, třeba v Eclipsu nebo i obyčejném Kwritu to obarveno je. Jaký používáte editor?

[pet I.]

Emacs a vzhledem k tomu, ze už ho používám téměř 20 let, tak si na nic jiného už zvykat nemíním. Jasně, mohl bych si v elispu dopsat zvýraznění pro #if 0, ale proč bych to dělal když Emacs má podporu pro korektní blokové komentování/odkomentování pro všechny jazyky které používám.

[Jindřich Makovička]

M-x hide-ifdef-mode

[Atom321]

To jste to ale špatně pochopil. Konstrukce #if 0 ... #endif není komentář, ale podmíněný blok pro překladač. Proto ho Eclipse (a každé slušné IDE) taky zvýrazňuje, ovšem pochopitelně jinak než komentář.

[Josef Kufner]

Ve Vimu to je obarveno také.

[pc2005]

Já mám s #if 0 problém v tom, že uvnitř toho bloku je občas nevalidní kód (přidání argumentu do volání funkce apod.). Navíc #if* bloky v kernelu nemaj rádi víc než ty rozbitý komentáře.

[Sten]

V #if 0 může být cokoliv kromě procesorových direktiv a kompilátor to ignoruje.

#if 0 se samozřejmě nemá nikdo dostat do commitovaného kódu. Řeší se tím, jak při ladění zakomentovat část kódu tak, aby jakékoliv zapomenuté zakomentování neprošlo přes checkpatch.

[pc2005]

To souhlas.

[kralyk z abclinuxu]

Dufam, ze nepovolia C++ // komentare. Pouzivam ich pri testovani a vyvoji na oznacenie nedokoncenych veci. Checkpatch mi ich potom pripomenie pri vytvarani finalnej verzie patchu.

Na tohle používám // FIXME, // TMP et al., což se grepuje bez problému...

[R]

Lenze teraz to nemusim grepovat - pred odoslanim patchu spustam checkpatch a ten mi popri inych chybach najde aj tieto veci.

[kralyk z abclinuxu]

Rozumim, to ale funguje jen u Linuxu (předpokládám, že mluvíš o kernelovském checkpatchi). Jsou jiné projekty s jiným codestyle, jiné jazyky...

[balki]

Stacil by skript, co to pred commitom sformatuje, aby bola jednotna stabna kultura. Netreba potom objavovat koleso a hadat sa o blbostiach.

[pc2005]

Existujou vyjímky, které porušují některou se zásad. Například 80 znaků na řádek pro nějakou komplikovanou strukturu, hexa naplnění pole apod.

[Sten]

Nestačil. Každý automatický nástroj je dobrý sluha, ale zlý pán. Někdy je důvod coding style porušit, a bohužel takovému nástroji se to blbě vysvětluje.

[Saljack]

Pak by to slo udelat tak, ze kod, ktery se nema formatovat bude uzavren mezi dva jednoradkove komentare neco jako:

//@no-format
tohle v zadnem pripade neformatuj.
//@end-no-format

[Xerces]

A víš jak by to skončilo, viď?

[tacoberu]

Na Wiki to skončilo dobře. Tam se to s úspěchem používá, respektive nepoužívá, respektive používá fakt jen když je to nutné...