CommentWracając do poprzedniego wpisu, w którym została stworzona metoda rozszerzająca . Jak można dodać opis/ komentarz do naszej metody/klasy tak, abyśmy później przy tworzeniu/użyciu otrzymywali chmurkę z Visual Studio informującą, co ta klasa/metoda robi.
Aby dodać taki opis jak widać na obrazku wystarczy dodać poniższy kod przed metodą.
/// <summary>
/// Metoda rozszerzeniowa.
/// Potęguje podaną liczbę.
/// </summary>
/// <param name="i">liczba</param>
/// <returns>power</returns>
public static int Power(this int i)Opis metody bądź klasy jest zawarty w tagu <summary>. Jak widać do kodu możemy też dodać opis parametrów jak i komentarz do wartości zwracanej.
W Visual Studio 2010 proces ten jest bardzo ułatwiony. Dodanie trzech /// od razu tworzy gotowy wzór do opisu naszej metody bądź klasy.
Dokumentowanie kodu z pewnością umożliwi nam w przyszłości łatwiejszy powrót do starego kodu. Kiedy pracujemy w zespole łatwiejsze jego zrozumienie pomiędzy członkami grupy.
W następnym wpisie opiszę, jak korzystając z zaawansowanych narzędzi np. GhostDoc uczynić dokumentowanie bardziej przyjemnym i efektownym.
Więcej informacji o tagach, jakie można stosować w dokumentacji tutaj.
