Soci (Soczó Zsolt) szakmai blogja

2009.09.30.

Sandcastle és társai

Filed under: .NET,C#,Szakmai élet,Visual Studio,VS 2005,VS 2008 — Soczó Zsolt @ 19:42

Az NDoc halott, van helyette SandCastle. Nagyon jó, imádom. Ezzel csinálják a VS doksiját is. Van még kétely valakiben?
Az is jó, hogy nem kell kézzel írnom a konfigját, mert van hozzá Sandcastle Help File Builder, ami hasonló GUI, mint az ndochoz volt.
Aztán, hogy ne kelljen sokat gépelni az xml kommenteket, ott a GhostDoc. Beépül a VS-be, és CTRL-ALT-D-vel létrehoz egy komment vázat az adott kódrészhez. Meglepően ügyesen, ha angol neveket használunk a kódban.
Mindhárom eszköz zseniális és INGYENES. Aki ezek után nem dokumentálja a kódját, annak 1-es. :)

6 Comments

  1. Ctrl-Alt-D? Bonyolult. Jobb IDE-k mar a tripla perjelre feldobjak a dokumentacios vazat. Az mindig csak 1 billentyu, igaz haromszor kell megnyomni, de meg mindig gyorsabb, mint billkombot nyomni.

    Comment by hrongyorgy — 2009.09.30. @ 23:56

  2. Fogom az élcet, de nem. :)
    A VS tud alapban komment vázat generálni, de nézd meg a fenti programot, és rájössz, hogy van értelme a 3 billentyűnek, messze nem ugyanaz a kettő.

    Comment by Soczó Zsolt — 2009.10.01. @ 07:05

  3. A GhostDoc-ban még az a jó, hogy – mint minden humán nyelvvel zsonglőrködő gép eszköz – néha nagyon vicces tud lenni. :)

    Comment by geri — 2009.10.01. @ 14:07

  4. Nyehem, de annak aki azzal generálja bele a kommentet és már csekkeli is be … ejnye bejnye.
    (Én azt szeretem nagyon, hogy egy már kommentezett interfész vagy ős kommentjeit átmásolja a leszármaztatott metódus kommentnek.)

    Comment by gerleim — 2009.10.01. @ 23:21

  5. @Soczó Zsolt: igen, pontosan errol beszeltem. Ugyan nem probaltam meg ki a programot, de igy latatlanban is pontosan sejtem, mik lehetnek a kulonbsegek a ketto kozt (parameterlista felderitese, esetleg a metodusnev belerakasa a dokumentacios kommentbe, stb.). Az igazan cool az lenne, ha a VS beepitett kommentgeneralo cuccat biralna felul. Vagy legalabb integralasra kerulne a kovetkezo VS SP-be.

    Comment by hrongyorgy — 2009.10.02. @ 05:20

  6. @gerleim: Persze. Ez egyébként is csak váz, még ha sikerül is szintaktikailag / szematikailag épkézláb mondatot összehozni, önmagában sok információt nem tartalmaz (public Foo GetFoo() -> “Gets the Foo”, köszi, sejtettem amúgy is; az msdn-ben is ezeket a magyarázatokat szeretem a legjobban).

    Comment by geri — 2009.10.02. @ 07:24

RSS feed for comments on this post.

Sorry, the comment form is closed at this time.

Powered by WordPress