documentation

7Ciepło

2Odpowiedz

Jak udokumentować istniejącą małą witrynę internetową (aplikację internetową) wewnątrz i na zewnątrz?

Mamy "aplikację internetową", która została opracowana w ciągu ostatnich 7 miesięcy. Problem polega na tym, że nie było tak naprawdę udokumentowane. Wymagania składały się z małej wypunktowanej listy

10Ciepło

1Odpowiedz

doxygen C++ inline szablon dokumentacji

Czy istnieje jakiś sposób, aby udokumentować parametrów szablonu tak: template< int N, ///< description typename T ///< description > zamiast wymieniając każdy parametr tparam? proszę zau

7Ciepło

2Odpowiedz

Jak wygenerować dokumentację msdn z javascript? najlepiej przy użyciu sandcastle

jest narzędzie, które można użyć do generowania dokumentacji typu msdn? Ostatnio zacząłem grać z zamkiem z piasku i odkryłem, że przyzwyczaił się do narzędzia o nazwie scriptdoc, ale zostało zaabsorbo

72Ciepło

3Odpowiedz

Jak dokumentować atrybuty klas w Pythonie?

Piszę lekką klasę, której atrybuty mają być publicznie dostępne, i tylko czasami przesłonięte w konkretnych wystąpieniach. W języku Python nie ma żadnego przepisu do tworzenia docstrukcji atrybutów kl

6Ciepło

3Odpowiedz

Jak udokumentować swój JavaScript?

Muszę udokumentować sporo kodu JavaScript i jQuery. Interesują mnie diagramy, a nie pisemna dokumentacja. Zastanawiam się, czy istnieje jakiś standard dla modelowania funkcji JavaScript? Moim celem je

24Ciepło

2Odpowiedz

Jak piszesz swoją dokumentację pakietu?

Nie do końca zrozumiałem sensowny przepływ pracy dla budowania pakietów i pisania ich dokumentacji. Chcę, aby jak najwięcej procesu (i dokumentacji) było generowane automatycznie. Oczywistym sposobem

22Ciepło

4Odpowiedz

Dokumentowanie funkcji w C++ przy użyciu Doxygen

Mam projekt, w którym używam Doxygen do generowania dokumentacji. Dokumentacja zajęć jest w porządku, ale mam także kilka funkcji, których używam w main() do tworzenia obiektów itp. Chciałbym również

21Ciepło

5Odpowiedz

Czy istnieje standardowy styl dokumentacji w PHP?

Jestem nowy w rozwoju PHP i zastanawiam się, czy społeczność ma jakiekolwiek wytyczne dotyczące wbudowanej dokumentacji kodu za pomocą komentarzy. Uwielbiam coś takiego jak Python PEP 257, ale zadowal

8Ciepło

3Odpowiedz

Dokumentacja (XML) Ustawienia aplikacji w Visual Studio 2010

Niedawno utworzyłem projekt (C#) w Visual Studio (2010) i użyłem niektórych ustawień (które utworzyłem w obszarze Właściwości). Jedyne miejsce, w którym mogę dodać komentarze XML do mojej dokumentacji

14Ciepło

2Odpowiedz

Gdzie znajduje się dokumentacja NUnit.Mocks?

Gdzie jest dokumentacja dla szyderczej biblioteki NUnit, NUnit.Mocks? Nie mogę znaleźć niczego w ich official documentation lub wiki.