Komentáře v programu: anglicky

8.1.2006 23:41 | Plané filozofování

Když píšu program, identifikátory dělám zásadně anglické. Komentuji taky anglicky a zjistil jsem, že mě to nutí líp programovat.

Samozřejmě se anglicky vyjádřuji hůř, než česky. Takže pokud jsem schopen napsat dobrý (jednoduchý) anglický kometář, znamená to, že mám program rozumně strukturovaný a komentované celky mají jasně vymezenou funkci.

Občas takový kometrář nejsem schopen napsat. To má zpravidla dva důvody.

• Jedná se o reálně složitou věc (obvykle pro nějaké konkrétní zákaznické prostředí). V takovém případě nemá cenu, abych to zatemňoval kostrbatou angličtinou, a bez výčitek to popíšu česky.
• Jedná se o blbě napsanou "jednoduchou" věc. Místo složitého komentáře se možná vyplatí zjednodušit program.

Refactoring v Eclipse rulez!-)

       

Komentáře

[Pavel Stárek]

Nojo, komentáře ..... to je takový obecný problém. Nejradši bych je nepsal, ale zase po nahlédnutí do zdrojáků po roční pauze si člověk nemusí myslet jestli autor byl génius nebo idiot

[0]

Pis vsechno anglicky geeku, i kostrbata anglictina je pro cca 4 miliardy lidi srozumitelnejsi nez bezvadna cestina.

[paskma]

No jasně. Česky si to dovolím jenom v práci. Jednak jsou tam ty "reálné složité problémy" a druhak to tak dělají kolegové. Soukromé věci teoreticky publikovatelené jedině anglicky.

[David Watzke]

Amen.

[Non_E]

Obecně snad taky píšu komentáře anglicky, ale poznámky typu "Nechápu, jak to funguje…" apod. se do cizích řečí radši překládat nesnažím.

[vencour]

Jak to vypadá, tak poprvé budu psát komentáře anglicky, v javě a pro generování html. Zatim jsem psal (když už jsem něco psal), tak česky, nebo spíše "cesky".

[vencour]

P.S. jak tak zjistuju, tak psani promennych anglicky zavani konfliktem s klicovymi slovy jazyka. No, nak si s tim poradim.

[elviin]

Vedle anglictiny doporucuju navic pouzivat Doxygen. Coz neni dobry jen pro me, ale pro kohokoliv, kdo si vygeneruje dokumentaci.

[Josef Kufner]

Jo, ty obrazky se tam obcas hodi :)

[tomm]

I v praci vsechno anglicky, od identifikatoru, komentaru, commitu po chybova hlaseno, todo, atd. ...

[anicka]

On ten, kdo pise komentare cesky, prestane ve chvili, kdy se mu dostane do ruky prvni zdrojak komentovany korejsky ;o))

[Marek Stopka]

Vlastní zkušenost?

[anicka]

To zrovna ne, ale dotycneho osobne znam .o)

[Marek Stopka]

Který pokoj v Bohnicích obsadil, že bych se stavil na návštěvu

[barney]

české (resp slovenské) komentáre ... v akom kôdovaní? )