Pytania dotyczące pisania komentarzy w kodzie.
Wiele osób twierdzi, że „komentarze powinny wyjaśniać„ dlaczego ”, ale nie„ jak ””. Inni twierdzą, że „kod powinien być samodokumentujący”, a komentarze powinny być rzadkie. Robert C. Martin twierdzi, że (przeformułowany na moje własne słowa) często „komentarze są przeprosinami za źle napisany...
Jeden z członków mojego zespołu konsekwentnie unika komentowania swojego kodu. Jego kod nie dokumentuje się sam, a inni programiści mają trudności ze zrozumieniem jego kodu. Kilkakrotnie prosiłem go o skomentowanie jego kodu, jednak on tylko usprawiedliwia lub twierdzi, że zrobi to później....
Pracowałem w sklepach, które produkują oprogramowanie krytyczne dla życia i zajmowałem się regułami komentowania, które miały na celu utrzymanie czytelności kodu i potencjalne uratowanie życia. Z mojego doświadczenia wynika jednak, że wymóg ten staje się umysłem, od którego należy usunąć listę...
Mój współpracownik uważa, że każde użycie komentarzy w kodzie (tj. Nie metoda w stylu javadoc lub komentarze do klasy) to zapach kodu . Co
młodszy programista tutaj. Obecnie pracuję sam nad aplikacją internetową dla dużego klienta mojej firmy. Zacząłem w zeszłym miesiącu. Klient chce co najmniej 25% komentarzy w każdym swoim projekcie oprogramowania. Sprawdziłem kod poprzednich aplikacji i oto moje spostrzeżenia: każdy plik...
Pracuję nad dość dużym projektem i dostałem zadanie wykonania kilku tłumaczeń. Było mnóstwo etykiet, które nie zostały przetłumaczone i podczas gdy przeglądałem kod, znalazłem ten mały fragment kodu //TODO translations To sprawiło, że pomyślałem o znaczeniu tych komentarzy dla siebie (i...
Napisałem następujący kod: if (boutique == null) { boutique = new Boutique(); boutique.setSite(site); boutique.setUrlLogo(CmsProperties.URL_FLUX_BOUTIQUE+fluxBoutique.getLogo()); boutique.setUrlBoutique(CmsProperties.URL_FLUX_BOUTIQUE+fluxBoutique.getUrl());
Rozmawiam z moimi nowymi kolegami o komentarzach. Oboje lubimy Clean Code , i jestem całkowicie w porządku z faktem, że należy unikać komentarzy do kodu wbudowanego, a nazwy klas i metod powinny być używane do wyrażania tego, co robią. Jednak jestem wielkim fanem dodawania małych podsumowań klas,...
Po pierwsze, w tym pytaniu chciałbym trzymać się z dala od polemiki dotyczącej tego, czy komentowanie kodu źródłowego jest dobre czy złe. Po prostu staram się lepiej zrozumieć, co ludzie mają na myśli, gdy mówią o komentarzach, które mówią DLACZEGO, CO I JAK. Często widzimy wytyczne takie jak...
Wiem, że Subversion (to, czego używamy w pracy) można skonfigurować tak, aby wymagało komentarzy na temat zatwierdzeń, ale nie jestem w stanie po prostu włączyć tego. Wiem, że moim powodem do komentowania moich zatwierdzeń jest to, że przydatne, choćby jako pamięć-jogger, jest szybkie zrozumienie...
Uczę się od mojego szefa (właśnie skończyłem szkołę i chciał kogoś z małym doświadczeniem programistycznym, więc wybrał mnie, aby mnie wyszkolić w zakresie tego, w czym ta firma się specjalizuje) i zaczął pracować z aplikacjami ASP.NET MVC , niektórymi HTML i CSS . Nie mam nic przeciwko...
Co ludzie zazwyczaj oznaczają, gdy widzisz XXXw komentarzu. Czasami zobaczę taki komentarz: # XXX - This widget really should frobulate the whatsit Oczywiście mogę powiedzieć, co oznacza komentarz, ale co ogólnie oznacza XXX? Czy to mówi „To jest hack”, a może „Może powinniśmy wrócić do tego...
Właśnie znalazłem, że piszę następujący komentarz w jakimś (archaicznym Visual Basic 6.0) kodzie, który pisałem: If WindowState <> 1 Then 'The form's not minimized, so we can resize it safely '... End if Nie jestem pewien, dlaczego podświadomie używam słowa „my” w swoich komentarzach....
tło Pracuję w zespole, który chce wdrożyć wdrożenia bez przestojów. Aby to osiągnąć, planujemy zastosować niebiesko-zieloną strategię wdrażania. Jedną z rzeczy, które zdaję sobie sprawę z przeprowadzania badań, jest to, jak skomplikowane jest wprowadzanie zmian w bazie danych. Prosta operacja,...
Ktoś kiedyś powiedział, że powinniśmy poprzedzić wszystkie nasze metody /// <summary>blokami komentarzy (C #), ale nie wyjaśnił dlaczego. Zacząłem ich używać i zauważyłem, że trochę mnie denerwują, więc przestałem ich używać, z wyjątkiem bibliotek i metod statycznych. Są nieporęczne i zawsze...
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...
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...
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...
W trakcie programowania pojawi się kilka komentarzy wyjaśniających kod i kilka komentarzy usuwających kod: // A concise description const a = Boolean(obj); //b = false; Czy istnieje dobra metoda szybkiego parsowania, która jest która? Bawiłem się przy użyciu 3 /i /** */do opisowych...
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...