GhostDocGhostDoc to dodatek do Visual Studio, który umożliwia nam tworzenie dokumentacji według naszych zasad czy algorytmu.

Program instalacyjny można pobrać z tej strony:http://submain.com/products/ghostdoc.aspx

Po instalacji trzeba uruchomić Visual Studio. Gdy to zrobimy zobaczymy okno dialogowe, z którego wybieramy skrót klawiszowy do tworzenia komentarzy.

Z menu “tools” w zakładce “GhostDoc” wybieramy “options” by ustawić te właśnie zasady.
Na start powiem, że ten cały GhostDoc to niegłupi pomysł np. kompilator wie, że dana właściwość jest tylko do odczytu więc z góry automatycznie powinien być dodany komentarz z tą informacją. .

Zasady komentarzy w GhostDoc_thumb[3]

Interface programu

 

Schody się zaczynają wtedy,  gdy chcemy dodać swoje zasady do utworzonego pliku. Spędzenie paru dni z tym programem byłoby wtedy nieuniknione.

Patrząc na zestaw gotowych zasad, wygenerowany komentarz, ważne są też nazwy np. metod. Jeśli metoda zaczyna się od “On” to znaczy , że wykonuje się ona podczas np. błędu pobierania “OnDownloadingFailure()”. Jeśli metoda zaczyna się od “Is” to powinna zwracać wartość bool do danego tematu np. “IsReadOnly()”.

Sam GhostDoc uczy więc programistę trzymania się odpowiedniego nazewnictwa. Program na pewno ułatwia dokumentacje.