Xml komentáře ve MS Visual C#

Duch

2. 8. 2006 #1

Neví někdo jak odstranit z kódu xml komentáře? Tedy zakázat je aby se při vytvoření nového projektu nezobrazovaly? Dost mě ruší.

Nahlásit jako SPAM

IP: ...–

DeaLer+2

Hero

Kultivátor příspěvků ve starém fóru – 2.01 % z celku

2. 8. 2006 #2

OT: tyto XML kometáře slouží ke generování dokumentace s pomocí nástrojů NDoc [http://ndoc.sourceforge.net/] a Sandcastle [http://www.microsoft.com/downloads/details.aspx?FamilyID=E82EA71D-DA89-42EE-A715-696E3A4873B2&displaylang=en]

K věci: osobně negeneruju dokumentaci tímto způsobem a XML komentaře vůbec nepoužívám. Po vytvoření projektu ve VS 2005 (pokud máš VS 2003, tak Tě lituju) jsou automaticky generované komentáře v souboru Program.cs a pak v souborech s příponou .Designer.cs (je to partial class designeru, který je ve VS 2003 v hlavním souboru .cs a může způsobovat nepřehlednost kódu), takže ve VS 2005 s tím není žádný problém. Pokud vím, tak není možné XML komentáře vypnout.

Nahlásit jako SPAM

IP: ...–

Dušan Janošík | web: djanosik.cz, @djanosik

Milan K?epelka 0

Duch

3. 8. 2006 #3

Ahoj, dost mě tvůj příspěvek překvapil. Komentáře k elementům jazyka považuji jako dost dobrou vychytávku. Nehledě na to, že ve spojení s intellisens je to pomocník k nezaplacení.

Nahlásit jako SPAM

IP: ...–

DeaLer+2

Hero

3. 8. 2006 #4

cicobasket napsal:

Ahoj, dost mě tvůj příspěvek překvapil. Komentáře k elementům jazyka považuji jako dost dobrou vychytávku. Nehledě na to, že ve spojení s intellisense je to pomocník k nezaplacení.

Já vím, že spousta lidí považuje XML komentáře za dobrou věc, ale podle mě zbytečně zdržujou od práce, když nehodláš generovat dokumentaci - v takovém případě stačej běžné komentáře, nebo ne?

BTW: nevím jakej je to pomocník a proč to spojuješ s IntelliSense.

Nahlásit jako SPAM

IP: ...–

Dušan Janošík | web: djanosik.cz, @djanosik

Milan Křepelka 0

Duch

3. 8. 2006 #5

zkus tedy uhodnout, kde se vzal text v červeném rámečku, takto lze okomentovat i jednotlivý parametry metod

Nahlásit jako SPAM

IP: ...–

DeaLer+2

Hero

3. 8. 2006 #6

cicobasket napsal:

zkus tedy uhodnout, kde se vzal text v červeném rámečku, takto lze okomentovat i jednotlivé parametry metod

JJ - jen jsem tě tak úplně nechápal (nedošlo mi to).

/// <summary>

/// popis metody

/// </summary>

/// <param name="sender">popis parametru</param>

/// <param name="e">popis parametru</param>

Tohle je samozřejmě dobrá v+c, ale používám ji jen u veřejných metod a objektů a jen když jde o něco, co bude déle využívané, ale někdo takhle popisuje pomalu každou metodu, třídu, atd. a to je podle mě zbytečnost.

Nahlásit jako SPAM

IP: ...–

Dušan Janošík | web: djanosik.cz, @djanosik

Milan Křepelka 0

Duch

3. 8. 2006 #7

ok,

ale ve v?ce lidech je imho takov?to komentov?n? nezbytnost. Nav?c kdo si v ?ervnu pamatuje co d?lal v lednu ? J? sem zapomn?tlivej, j? komentuju (metody, fieldy, property, skoro v?echno. Jenom jsem si u? odvykl komentovat k?d. Po refaktorov?n? to prej nen? pot?aba ;-)

Nahlásit jako SPAM

IP: ...–

DeaLer+2

Hero

3. 8. 2006 #8

cicobasket napsal:

ok,

ale ve více lidech je imho takovéto komentování nezbytnost. Navíc kdo si v červnu pamatuje co dělal v lednu? Já jsem zapomnětlivej, já komentuju metody, fieldy, property, skoro všechno. Jenom jsem si už odvykl komentovat kód. Po refaktorování to prej není potřeba ;-)

JJ - souhlasím. Ve více lidech je to určitě potřeba. Já bych se ve svém kódu po nějakém čase asi taky nevyznal, ale tomu se bráním používáním běžných komentářů?.

Nahlásit jako SPAM

IP: ...–

Dušan Janošík | web: djanosik.cz, @djanosik

← Zpět na seznam vláken ← Zpět do Fóra