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...
Zamknięte . To pytanie jest oparte na opiniach . Obecnie nie przyjmuje odpowiedzi. Chcesz poprawić to pytanie? Zaktualizuj pytanie, aby można było na nie odpowiedzieć faktami i cytatami, edytując ten post . Zamknięte 5 lat temu . Widziałem to w SO Tavern...
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...
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...
Zamknięte . To pytanie jest oparte na opiniach . Obecnie nie przyjmuje odpowiedzi. Chcesz poprawić to pytanie? Zaktualizuj pytanie, aby można było na nie odpowiedzieć faktami i cytatami, edytując ten post . Zamknięte 4 lata temu . Zaczynam dopiero od...
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ś...
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...
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ę...
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ąż...
Szukam zalecenia najlepszych praktyk dla komentarzy XML w języku C #. Podczas tworzenia właściwości wygląda na to, że oczekiwana dokumentacja XML ma następującą postać: /// <summary> /// Gets or sets the ID the uniquely identifies this <see cref="User" /> instance. ///...
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...
Widziałem wiele numerów numerów z komentarzy kodu jQuery . (W rzeczywistości w kodzie jQuery było 69 numerów numerów.) Myślę, że to dobra praktyka, ale nigdy nie widziałem żadnych wytycznych. Jeśli jest to dobra praktyka, jakie są wytyczne dla tej
Zamknięte . To pytanie jest oparte na opiniach . Obecnie nie przyjmuje odpowiedzi. Chcesz poprawić to pytanie? Zaktualizuj pytanie, aby można było na nie odpowiedzieć faktami i cytatami, edytując ten post . Zamknięte 4 lata temu . Często widziałem takie...
O ile wiem, kilka osób to robi, ale żaden z nich nie jest popularny. Czy jest coś złego w zagnieżdżaniu komentarzy? Planuję mieć blokowane komentarze w (małym) języku, nad którym pracuję, ale chciałbym wiedzieć, czy to zły
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...
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...
W dość niektórych bazach kodów można zobaczyć komentarze stwierdzające takie rzeczy jak: // Workaround for defect 'xxx', (See bug 1434594 on Sun's bugparade) Mam więc kilka pytań, ale wszystkie są powiązane. Czy w komentarzach programu można umieścić link do pytań SO: // We're now mapping...
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...
Czy uważanie NotImplementedExceptionza kod, którego jeszcze nie napisałeś, jest uważane za złą praktykę ? Być może komentarze do zrobienia TODO będą uważane za
Trudno powiedzieć, o co tu pytają. To pytanie jest dwuznaczne, niejasne, niepełne, zbyt szerokie lub retoryczne i na obecną formę nie można w rozsądny sposób odpowiedzieć. Aby uzyskać pomoc w wyjaśnieniu tego pytania, aby można je było ponownie otworzyć, odwiedź centrum pomocy ....