Chcę cię zapytać, czy dodanie niektórych „pisanek” do dokumentacji źródłowej jest nieprofesjonalne, czy nie. Prawdopodobnie przeczytałeś sondę StackOverflow, aby uzyskać śmieszne komentarze w dokumentacji źródłowej, a ja osobiście natknąłem się na wiele takich rzeczy podczas mojej pracy, w tym śmieszne (lub nie) rzeczy w publicznej dokumentacji API (na przykład ta słaba BZZZTT !! 1! Rzecz ! w publicznej dokumentacji Androida mogę podać co najmniej kilkanaście innych przykładów).
Nie mogę dojść do ostatecznej opinii, ponieważ mam sprzeczne ze sobą argumenty.
Argument pro:
- Może kogoś pocieszyć i sprawić, że jego / jej dzień będzie zabawniejszy / bardziej produktywny. Większa część kodu źródłowego i tak nie musi być komentowana (jeśli projekt jest wykonany poprawnie), ponieważ konkretna metoda (na przykład) jest łatwa do wyjaśnienia lub jeśli jest stosem dziwnego, kiepskiego kodu, nie może zostać wyjaśnione w sensowny sposób, aby śmieszny dowcip nie zaszkodził możliwym informacjom, które można uzyskać od doktora.
Argument przeciw:
- Jeśli jesteś bardzo skoncentrowany / sfrustrowany, ostatnią rzeczą, której potrzebujesz, jest czyjś głupi żart, zamiast dostarczania potrzebnych informacji na temat udokumentowanej części kodu, może sprawić, że będziesz jeszcze bardziej sfrustrowany. Pomysł, jak wyglądałaby dokumentacja, gdyby wszyscy zaczęli to robić, jest okropny. Dodatkowo facet, który pisze żart, może być jedynym, który uważa, że przeczytanie go jest śmieszne / interesujące / warte marnowania czasu.
Co myślisz?