Ohayo! Powiedzcie mi Mircy, jaki system dokumentowania kodu byście polecali? Chcę niedługo siąść do dokumentacji standardowej biblioteki i potrzebowałbym stworzyć narzędzie, które parsowałoby komentarze przed kodem i budowało ze sformatowanej struktury tekstu opis zdolny do wyświetlenia w dokumentacji.
@PsichiX: Najlepiej nie dokumentować. Wtedy tylko ty ogarniasz projekt i nie mogą cie zwolnić a możesz nawet zapytać o podwyżkę. Czyli mniej pracy a więcej pieniędzy.
id do struktury PMMessage? Obecnie brakuje takiego pola, co powoduje, że w przypadku posłania dwóch komunikatów w tej samej sekundzie (co jest dość proste do zrobienia), nie można polegać na dacie jako zamienniku id w kontekście danej konwersacji.
Przy okazji, dokumentacja rozmija się z rzeczywistością bowiem wg dokumentacji:
PMMessage
date Data ostatniej wiadomości date
a data tak naprawdę wskazuje (to co w tym przypadku jest
To jest wstępna dokumentacja dodatku, który stworzyłem. Niech ktoś, kto ogarnia czytanie dokumentacji przejrzy i powie czy da się z tego coś zrozumieć i na tej podstawie coś napisać, będę wdzięczny.
"Czy oświadczenie — „Zawsze tak to robimy” nie budzi w Tobie jakiejś wątpliwości?
Amerykański standard szerokości torów kolejowych (odstępu szyn) wynosi 4 stopy, 8.5 cala. Prawda, że to dziwaczna liczba? A czy wiesz dlaczego taki właśnie standard się stosuje?
Ponieważ w ten sposób buduje się linie kolejowe w Anglii, a właśnie angielscy przybysze budowali amerykańskie linie kolejowe. Dlaczego jednak Anglicy budowali je właśnie tak?
@anonim1133: Tak, a nawet nie. Jak teraz na to patrzę, to rzeczywiście troszkę z dupy, ale tekst pierwszy raz znalazłem na blogu jakiegoś programisty i zawsze będę odbierał go pod takim kątem. Koleś chciał pokazać, że programując nie można stosować jakichś rozwiązań bo "zawsze tak to robimy" albo "wszyscy tak robią", ale trzeba wiedzieć dlaczego właśnie tak robimy, bo może się okazać, że był to powód, który nie jest adekwatny do
piotrgankiewicz.com/2016/12/12/documentation-as-a-project-booster/
#programowanie #programista15k #dotnet #csharp #blog #spetz #informatyka #dokumentacja