Dokumentace v C# jak psát? – .NET – Fórum – Programujte.com
 x   TIP: Přetáhni ikonu na hlavní panel pro připnutí webu
Reklama
Reklama

Dokumentace v C# jak psát? – .NET – Fórum – Programujte.comDokumentace v C# jak psát? – .NET – Fórum – Programujte.com

 

Hledá se programátor! Plat 1 800 € + bonusy (firma Boxmol.com)
martin
~ Anonymní uživatel
1379 příspěvků
12. 2. 2015   #1
-
0
-

Dobrý den,

začínám dělat na menším projektu v C# a přemýšlím jak se píše v C# dokumentace funkcí.

Jsem zvyklý z php na zápis dokumentace, ale asi není vhodné ho plést do C#, kde jsou jiné konvence, mám pravdu?

Našel jsem, že se dokumentace píše v tomto stylu:

Připojen obrázek.

Mám tedy psát dokumentaci takto? je to správně?

Nahlásit jako SPAM
IP: 62.168.31.–
Reklama
Reklama
RomanZ
~ Anonymní uživatel
244 příspěvků
12. 2. 2015   #2
-
0
-

Ano, podle mne je to spravne. Pokud pouzivas visual studio, tak napis nad nazvem metody tri lomitka za sebou a ono to vygeneruje kostru pro dokumentaci - ty sede texty. Pak tam uz jen dopises ty zelene texty. 

Pokud je dokumentace napsana timto stylem, tak se z ni necha vygenerovat dokument. Ale hlavne, takhle napsanou dokumentaci rozpozna intellisense a pak pri psani kodu napovida uplne stejne, jako u trid od microsoftu.

Nahlásit jako SPAM
IP: 79.127.137.–
Zjistit počet nových příspěvků

Přidej příspěvek

Toto téma je starší jak čtvrt roku – přidej svůj příspěvek jen tehdy, máš-li k tématu opravdu co říct!

Ano, opravdu chci reagovat → zobrazí formulář pro přidání příspěvku

×Vložení zdrojáku

×Vložení obrázku

Vložit URL obrázku Vybrat obrázek na disku
Vlož URL adresu obrázku:
Klikni a vyber obrázek z počítače:

×Vložení videa

Aktuálně jsou podporována videa ze serverů YouTube, Vimeo a Dailymotion.
×
 
Podporujeme Gravatara.
Zadej URL adresu Avatara (40 x 40 px) nebo emailovou adresu pro použití Gravatara.
Email nikam neukládáme, po získání Gravatara je zahozen.
-
Pravidla pro psaní příspěvků, používej diakritiku. ENTER pro nový odstavec, SHIFT + ENTER pro nový řádek.
Sledovat nové příspěvky (pouze pro přihlášené)
Sleduj vlákno a v případě přidání nového příspěvku o tom budeš vědět mezi prvními.
Reaguješ na příspěvek:

Uživatelé prohlížející si toto vlákno

Uživatelé on-line: 0 registrovaných, 54 hostů

 

Hostujeme u Českého hostingu       ISSN 1801-1586       ⇡ Nahoru Webtea.cz logo © 20032016 Programujte.com
Zasadilo a pěstuje Webtea.cz, šéfredaktor Lukáš Churý