Pytania otagowane jako documentation-generation

4
Czy BDD jest w rzeczywistości zapisywalny przez osoby niebędące programistami?
Rozwój oparty na zachowaniach z charakterystyczną składnią scenariuszy „Given-When-Then” został ostatnio podekscytowany ze względu na możliwe zastosowania go jako obiektu granicznego do oceny funkcjonalności oprogramowania. Zdecydowanie zgadzam się, że korniszon , lub jakikolwiek skrypt definicji funkcji, który wolisz, jest czytelną dla biznesu DSL i już zapewnia taką wartość. Jednak nie …
6
Jak udokumentować swój kod w celu sprawdzenia jego minimalnego czasu? [Zamknięte]
Zamknięte . To pytanie musi być bardziej skoncentrowane . Obecnie nie przyjmuje odpowiedzi. Chcesz poprawić to pytanie? Zaktualizuj pytanie, aby skupiało się tylko na jednym problemie, edytując ten post . Zamknięte w zeszłym roku . Chcę udokumentować mój kod w taki sposób, aby minimalne zapotrzebowanie na czytanie i przeglądanie kodu …
1
Czy powielanie dokumentacji dotyczącej implementacji / zastąpień interfejsu jest dobre czy złe?
Mamy więc taki interfejs /// <summary> /// Interface for classes capable of creating foos /// </summary> public interface ICreatesFoo { /// <summary> /// Creates foos /// </summary> void Create(Foo foo); /// <summary> /// Does Bar stuff /// </summary> void Bar(); } Niedawno odtworzyliśmy historię dokumentacji, która polegała na wygenerowaniu i …
8
Gdzie umieścić dokumentację kodu?
Obecnie używam dwóch systemów do pisania dokumentacji kodu (używam C ++): Dokumentacja o metodach i członkach klasy jest dodawana obok kodu, w formacie Doxygen. Na serwerze Doxygen jest uruchamiany na źródłach, dzięki czemu dane wyjściowe można zobaczyć w przeglądarce internetowej Strony przeglądowe (opisujące zestaw klas, strukturę aplikacji, przykładowy kod, ...) …
3
Jak udokumentować eksperymentalne lub niekompletne interfejsy API, takie jak @deprecated?
Czy istnieje dobry termin, który jest podobny, ale różni się od „przestarzałe”, co oznacza, że ​​metoda lub interfejs API znajduje się w bazie kodu, ale nie należy go stosować, ponieważ jego implementacja nie jest kompletna lub prawdopodobnie ulegnie zmianie? (Tak, wiem, te metody nie powinny być publiczne, yada yada yada. …
5
Jakie elementy dostarcza klientowi aplikacja sieciowa? [Zamknięte]
Zamknięte . To pytanie musi być bardziej skoncentrowane . Obecnie nie przyjmuje odpowiedzi. Chcesz poprawić to pytanie? Zaktualizuj pytanie, aby skupiało się tylko na jednym problemie, edytując ten post . Zamknięte 4 lata temu . Ukończyłem aplikację internetową, która jest zasadniczo opracowana w PHP i jest po prostu kolejną zwykłą …
Korzystając z naszej strony potwierdzasz, że przeczytałeś(-aś) i rozumiesz nasze zasady używania plików cookie i zasady ochrony prywatności.
Licensed under cc by-sa 3.0 with attribution required.