Pytania otagowane jako javadocs

6
Kod samodokumentujący vs Javadocs?
Ostatnio pracuję nad refaktoryzacją części bazy kodu, z którą obecnie mam do czynienia - nie tylko po to, aby lepiej ją zrozumieć, ale także aby ułatwić innym, którzy pracują nad kodem. Zwykle opieram się na myśleniu, że samodokumentujący się kod jest fajny . Po prostu uważam, że jest czystszy i …
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. …
2
Przestarzałe vs. zmigrowane w JavaDoc?
W JavaDoc dla X509Certificate getSubjectDN()tego stwierdza: Przeniesiony , zastąpiony przez getSubjectX500Principal (). Przyzwyczaiłem się do wycofywania metod for, które nie powinny być już używane, ale nie poddane migracji. Znalazłem raport o błędzie dotyczący tego konkretnego przypadku, w którym został zamknięty z komentarzem: To nie jest błąd. „Przestarzałe” należy stosować tylko …
1
Jak aktualizować przykłady kodu w javadocs
Pracuję nad małą biblioteką, która zapewnia implementacje podstawowych, dobrze znanych metryk ciągu. Głównie dla mojej własnej edukacji. Rozwój odbywa się za każdym razem, gdy mam trochę wolnego czasu. Z tego powodu zautomatyzowałem większość procesów, dzięki czemu mogę wypuszczać wersję tak często, jak pracuję nad nią bez większego wysiłku. Jednak utrzymanie …
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.