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

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ě?

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.