Pytania otagowane jako comments

Pytania dotyczące pisania komentarzy w kodzie.

9
Konserwacja kodu: Aby dodać komentarze do kodu lub po prostu pozostawić kontrolę wersji?
Zostaliśmy poproszeni o dodanie komentarzy do tagów początkowych, końcowych, opisu, rozwiązania itp. Dla każdej zmiany, którą wprowadzamy do kodu w ramach naprawy błędu / implementacji CR. Obawiam się, czy zapewnia to jakąś wartość dodaną? W tej chwili mamy wszystkie szczegóły w historii kontroli wersji, które pomogą nam śledzić każdą zmianę? …
16
Dobry pomysł, aby wstawić numery błędów w komentarzu na początku pliku źródłowego? [Zamknięte]
Czy dobrą praktyką jest umieszczanie numerów błędów w samym pliku w komentarzu nagłówka? Komentarze wyglądałyby mniej więcej tak: MODIFIED (MM/DD/YY) abc 01/21/14 - Bug 17452317 - npe in drill across in dashboard edit mode cde 01/17/14 - Bug 2314558 - some other error description Wydaje się to pomocne, ale czy …
12
Czy nieaktualne komentarze to miejski mit?
Ciągle widzę ludzi twierdzących, że „komentarze stają się nieaktualne”. Chodzi o to, myślę, że widziałem może dwa lub trzy nieaktualne komentarze przez całą moją karierę. Nieaktualne informacje w osobnych dokumentach zdarzają się cały czas, ale z mojego doświadczenia wynika, że ​​nieaktualne komentarze w samym kodzie są niezwykle rzadkie. Czy mam …
38 comments  myth 
13
Skomentuj przed odpowiednim kodem lub po nim [zamknięte]
Zakładając, że komentarz nie pasuje (lub nie może przejść) do wiersza, którego dotyczy, czy należy napisać komentarz przed kodem, czy po nim? Cóż, gdziekolwiek przyszli czytelnicy najlepiej zrozumieją zakres komentarza. Innymi słowy, wszędzie tam, gdzie większość programistów / skryptów umieszcza takie komentarze. Gdzie więc większość programistów / skryptów komentuje: przed …
34 comments 
5
Jak zwykle parsowane są komentarze?
Jak ogólnie traktuje się komentarze w językach programowania i znacznikach? Piszę parser dla jakiegoś niestandardowego języka znaczników i chcę przestrzegać zasady najmniejszego zaskoczenia , więc staram się ustalić ogólną konwencję. Na przykład, czy komentarz osadzony w tokenie powinien „zakłócać” token, czy nie? Zasadniczo jest coś takiego: Sys/* comment */tem.out.println() ważny? …
31 parsing  comments 
6
Przewodnik dla początkujących po pisaniu komentarzy?
Chcesz poprawić ten post? Podaj szczegółowe odpowiedzi na to pytanie, w tym cytaty i wyjaśnienie, dlaczego Twoja odpowiedź jest poprawna. Odpowiedzi bez wystarczającej ilości szczegółów mogą być edytowane lub usuwane. To pytanie zostało przeniesione z przepełnienia stosu, ponieważ można na nie odpowiedzieć w programie Software Engineering Stack Exchange. Migrował 8 …
9
Styl i rekomendacje kodu komentującego
To pytanie zostało przeniesione z przepełnienia stosu, ponieważ można na nie odpowiedzieć w programie Software Engineering Stack Exchange. Migrował 8 lat temu . Chcę usłyszeć od ciebie wszelkie porady i doświadczenie w pisaniu komentarzy w twoim kodzie. Jak piszesz je w najłatwiejszy i najbardziej pouczający sposób? Jakie masz nawyki, komentując …
6
Jak rozwiązać problem zagnieżdżonych komentarzy
Pojawia się w nie tylko jednym języku, że komentarzy nie można zagnieździć. Czy masz dobre rozwiązanie tego problemu? Jednym z obejść w C / C ++ i Javie jest używanie tylko komentarza jednowierszowego, ale niemożliwe staje się wówczas komentowanie większego bloku. Mam do czynienia z czymś takim: </li><!-- <li><!-- Save …
23 java  c++  python  c  comments 
21
Kod samo dokumentujący vs. Skomentowany kod
Zablokowana . Komentarze do tego pytania zostały wyłączone, ale nadal akceptuje nowe odpowiedzi i inne interakcje. Dowiedz się więcej . Miałem wyszukiwanie, ale nie znalazłem tego, czego szukałem, proszę o link, jeśli to pytanie zostało już zadane. Wcześniej w tym miesiącu opublikowano ten post: http://net.tutsplus.com/tutorials/php/why-youre-a-bad-php-programmer/ Podsumowując, jesteś złym programistą, jeśli …
6
Dlaczego źle jest komentować kod, a następnie stopniowo go usuwać, aby śledzić to, co już zrobiłem i co pozostało do zrobienia?
Ilekroć dowiaduję się, że duża część mojego kodu musi zostać zmieniona, albo dlatego, że jest niepoprawna, albo dlatego, że musi zostać dostosowana do poważnych zmian architektonicznych spowodowanych innymi przyczynami, zazwyczaj tak robię: Komentuję cały kod, który, jak podejrzewam, może będę musiał zmienić. Skomentowany kod traktuję jako rodzaj mojej listy TODO. …
6
Najlepsze praktyki pisania komentarzy i dokumentacji
Komentowanie jest dziś łatwiejsze niż kiedykolwiek. W Javie istnieje kilka fajnych technik łączenia komentarzy z klasami, a środowiska IDE Java są dobre w tworzeniu powłok komentarzy. Języki takie jak Clojure pozwalają nawet dodać opis funkcji w samym kodzie funkcji jako argument. Jednak wciąż żyjemy w czasach, w których często są …
12
Poprawny komentarz do argumentów funkcji boolowskich, które są „fałszywe”?
Z niektórych projektów typu open source zebrałem następujący styl kodowania void someFunction(bool forget); void ourFunction() { someFunction(false /* forget */); } Zawsze mam wątpliwości, co falsetu oznacza. Czy oznacza to „zapomnieć”, czy też „zapomnieć” odnosi się do odpowiedniego parametru (jak w powyższym przypadku), a „fałsz” ma go zanegować? Jaki styl …
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.