Pytania otagowane jako comments

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 kod”. Moje pytanie jest następujące: Co jest złego …

236 programming-practices  documentation  comments 

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. Martwi go, że dodawanie komentarzy zajmie zbyt dużo …

182 teamwork  team  comments 

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ę kontrolną i nie pomaga mi skupić się na pisaniu …

142 coding-standards  comments  standards  naming-standards  standardization 

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 myślisz?

100 comments  anti-patterns 

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 zaczyna się od bloku komentarza (pakiet, data ostatniej aktualizacji, nazwa mojej …

96 project-management  comments  client-relations  hierarchy 

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 innych?), Ponieważ miałem wrażenie, że większość programistów po tym, …

86 documentation  comments 

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, które próbują wyjaśnić …

83 comments  clean-code 

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()); boutique.setNom(fluxBoutique.getNom()); boutique.setSelected(false); boutique.setIdWebSC(fluxBoutique.getId()); boutique.setDateModification(new Date()); boutiqueDao.persist(boutique); } else { boutique.setSite(site); boutique.setUrlLogo(CmsProperties.URL_FLUX_BOUTIQUE+fluxBoutique.getLogo()); boutique.setUrlBoutique(CmsProperties.URL_FLUX_BOUTIQUE+fluxBoutique.getUrl()); boutique.setNom(fluxBoutique.getNom()); //boutique.setSelected(false); boutique.setIdWebSC(fluxBoutique.getId()); boutique.setDateModification(new Date()); boutiqueDao.merge(boutique); } Jest tutaj komentarz z komentarzem. Ale myślę, że dzięki temu kod staje się bardziej przejrzysty, ponieważ …

83 documentation  comments 

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 „Komentarze powinny …

78 documentation  comments 

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 przyczyny zmiany. Nie wydaje się to …

78 version-control  comments 

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 projektowaniu stron internetowych, …

72 comments 

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 później”? A może mówi …

71 comments  coding-standards 

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. Podejrzewam, że dzieje się tak, ponieważ …

63 comments  coding-standards 

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, taka jak zmiana nazwy kolumny, może potrwać 3 pełne cykle …

51 continuous-integration  deployment  comments  continuous-delivery 

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 zapominam o ich aktualizacji. Czy jest jakiś dobry powód, …

49 c#  comments