Co znamená, když je v kódu
/// <sumary> a /// <param>
K čemu to slouží, musí to tam být???
Díky
Fórum › .NET
C# source code
ty lomitka vypadaji na komentare... obvykle to delaji lidi aby se ve svym kodu po par tydnech zase vyznali ...
v lepsim pripade aby se v tom vyznal i nekdo jiny...
A to Sumary a parram ???
Asi jsi měl na mysli /// <summary>, účel téhle věci je skoro stejný, jako obyčejných komentářů ( // ), ale z těchto tagů se navíc generuje XML dokumentace. Zároveň si z nich bere IntelliSense (takové to jak ti napovídá názvy tříd, metod, proměnných, ...) popisek jednotlivých objektů.
<param> slouží k dokumentaci parametrů předávaných metodě, příklad snad mluví za vše:
<param name="s1">Předává metodě nějaký string</param>
public static void Pozdrav(string s1)
{
MessageBox.Show(s1);
}
Vygenerování dokumetance můžeš dosáhnout třeba tím, že při kompilaci zadáš jako argument
/doc:MojeDokumentace.xml
Celkem je těchto tagů nějak kolem patnácti, popis všech je na MSDN.
Pak pro vygenerovani dokumentace v takto okomentovanem projektu muzes pouzit SandcatleBuilder.
[quote="dannyk"]Pak pro vygenerovani dokumentace v takto okomentovanem projektu muzes pouzit SandcatleBuilder.[/quote]
samotny XML subor Ti vytvori aj VS2008, jednoducho klikni na projekt pravym---properties---build(karta) a tam daj XML documentation...
a mas potom "human readable" dokument...
Ano,ale ten sandcastle ti z toho vygeneruje bud pdf nebo html stranky ve stylu MSDN apod.A to je myslim jeste vice "human readable" nez obyc xml.
Přidej příspěvek
Ano, opravdu chci reagovat → zobrazí formulář pro přidání příspěvku
×Vložení zdrojáku
×Vložení obrázku
×Vložení videa
Uživatelé prohlížející si toto vlákno
Podobná vlákna
[RE] - zamezení funkčnosti v bloku code - V code se BBCode nepřevádí — založil Nazghul-CZ
Open-Source c++ — založil Kenvelo
MS vs Open source — založil Lukáš Chadraba
Open Source projekt — založil sn3d
Moderátoři diskuze