Pytania otagowane jako comments

Pytania dotyczące pisania komentarzy w kodzie.

6
Czy konieczne jest napisanie komentarza javadoc do KAŻDEGO parametru w sygnaturze metody?
Jeden z deweloperów w moim zespole uważa, że ​​konieczne jest napisanie komentarza javadoc do KAŻDEGO parametru w sygnaturze metody. Nie sądzę, aby było to konieczne, a nawet uważam, że może być szkodliwe. Po pierwsze, uważam, że nazwy parametrów powinny być opisowe i samodokumentujące. Jeśli nie jest od razu oczywiste, do …
8
Czy wbudowane komentarze „edytowane przez” są normą w sklepach korzystających z kontroli wersji?
Starszy programista w naszym sklepie nalega, aby za każdym razem, gdy kod był modyfikowany, odpowiedzialny programista powinien dodawać wbudowany komentarz stwierdzający, co zrobił. Te komentarze zwykle wyglądają// YYYY-MM-DD <User ID> Added this IF block per bug 1234. Używamy TFS do kontroli wersji i wydaje mi się, że tego rodzaju komentarze …
9
Jaki jest dobry sposób na komentowanie klauzul if-else? [Zamknięte]
W obecnej formie to pytanie nie pasuje do naszego formatu pytań i odpowiedzi. Oczekujemy, że odpowiedzi poparte będą faktami, referencjami lub wiedzą fachową, ale to pytanie prawdopodobnie będzie wymagało debaty, argumentów, ankiet lub rozszerzonej dyskusji. Jeśli uważasz, że to pytanie można poprawić i ewentualnie ponownie otworzyć, odwiedź centrum pomocy w …
15 comments 
7
Co powinienem zawrzeć w nagłówku dokumentacji zajęć
Szukam pouczającego formatu dokumentacji klas dla moich klas Entity, Business Logic i Data Access. Znalazłem następujące dwa formaty stąd Format 1 ///----------------------------------------------------------------- /// Namespace: <Class Namespace> /// Class: <Class Name> /// Description: <Description> /// Author: <Author> Date: <DateTime> /// Notes: <Notes> /// Revision History: /// Name: Date: Description: ///----------------------------------------------------------------- Format …
4
Czy istnieje uzasadnienie dla pozostawienia znaczników konfliktu w zameldowanym kodzie?
Rozważ znaczniki konfliktu. to znaczy: <<<<<<< branch blah blah this ======= blah blah that >>>>>>> HEAD W szczególnym przypadku, który zmotywował mnie do opublikowania tego pytania, odpowiedzialny członek zespołu właśnie zakończył scalenie z wyższego szczebla do naszego oddziału, aw niektórych przypadkach pozostawił je jako komentarz, jako rodzaj dokumentacji dotyczącej tego, …
6
Adnotuj kod źródłowy za pomocą diagramów jako komentarzy
Piszę dużo kodu (głównie c ++ i javascript), który dotyczy geometrii obliczeniowej i grafiki oraz tego rodzaju tematów, więc odkryłem, że diagramy wizualne są nieodzowną częścią procesu rozwiązywania problemów. Właśnie ustaliłem, że „och, czy nie byłoby po prostu fantastycznie, gdybym mógł jakoś dołączyć ręcznie rysowany diagram do fragmentu kodu jako …
2
Jakie jest najlepsze podejście do komentarzy kodu wbudowanego?
Dokonujemy refaktoryzacji do 20-letniej bazy kodu starszego typu i rozmawiam z kolegą na temat formatu komentarzy w kodzie (plsql, java). Nie ma domyślnego formatu komentarzy, ale w większości przypadków ludzie robią coś takiego w komentarzu: // date (year, year-month, yyyy-mm-dd, dd/mm/yyyy), (author id, author name, author nickname) and comment proponowany …
1
Wprowadzenie dodatkowych zmiennych lokalnych jako zamienników komentarzy
Czy to dobry styl, aby używać dodatkowych, zbędnych technicznie zmiennych lokalnych, aby opisać, co się dzieje? Na przykład: bool easyUnderstandableIsTrue = (/* rather cryptic boolean expessions */); if(easyUnderstandableIsTrue) { // ... } Jeśli chodzi o narzut techniczny, oczekuję, że kompilator zoptymalizuje tę dodatkową linię. Ale czy jest to uważane za …
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.