Diskuze: Dokumentace v C#

C# .NET .NET (C# a Visual Basic) Dokumentace v C# American English version English version

Avatar
Kit
Redaktor
Avatar
Kit:

Na moji otázku ohledně dokumentace v C# ve srovnání s Javou Mediel napsal:

"Dělá se to stejně, ale přesto třeba ve firmě po mě chtějí ještě dokumentaci a když je to pro nějakého klienta, tak i manuál."

Nechápu, k čemu se v C# ještě dělá dokumentace, když se dá kompletně vygenerovat ze zdrojáků programu včetně křížových odkazů.

Manuál pro klienta chápu, i když i ten by měl jít vygenerovat z testovacích tříd.

Odpovědět 2.4.2013 11:43
Vlastnosti objektů by neměly být veřejné. A to ani prostřednictvím getterů/setterů.
Avatar
David Čápka
Tým ITnetwork
Avatar
Odpovídá na Kit
David Čápka:

Programátorská dokumentace se samozřejmě generuje z komentářů, C# je má dokonce řešené přes XML, což je velmi šikovné. Mediel měl asi na mysli uživatelský manuál.

Nahoru Odpovědět 2.4.2013 11:54
Miluji svou práci a zdejší komunitu, baví mě se rozvíjet, děkuji každému členovi za to, že zde působí.
Avatar
Kit
Redaktor
Avatar
Odpovídá na David Čápka
Kit:

Uživatelský manuál by se mohl generovat z testovacích tříd. Vím, že se testy dost zanedbávají, ale právě zde by mohl být prostor pro vytváření uživatelského manuálu. Pokud by to vývojáři dělali, uživatelský manuál by vznikal současně s aplikací.

Nahoru Odpovědět 2.4.2013 12:10
Vlastnosti objektů by neměly být veřejné. A to ani prostřednictvím getterů/setterů.
Děláme co je v našich silách, aby byly zdejší diskuze co nejkvalitnější. Proto do nich také mohou přispívat pouze registrovaní členové. Pro zapojení do diskuze se přihlas. Pokud ještě nemáš účet, zaregistruj se, je to zdarma.

Zobrazeno 3 zpráv z 3.