Dlaczego wszyscy piszą komentarze do zrobienia dużymi literami? [Zamknięte]

9

Robię to samo. Kiedy w moim kodzie jest coś do zrobienia, piszę //TODO .... Ale jestem ciekawy, kiedy to się zaczęło i czy istnieje powód, aby pisać „do-dos” dużymi literami?

comments

— Mohsen
źródło

20

Ponieważ naprawdę TO ZNACZYMY (po prostu nigdy się tym nie zajmujemy)

— Anthony Pegram

3

więc redaktorzy mogą je oznaczać i przeszukiwać je (na przykład lista zadań zaćmienia)

— maniak ratchet

6

Ponieważ nie można było pogrubić tekstu w kodzie, potrzebny był jakiś sposób wyróżnienia ważnych rzeczy. Stąd ...

— Karlson,

4

Dlaczego to ma znaczenie?

— Rook

3

Piszę//todo:...

— BЈовић

23

Poza tym świetnie jest mieć sposób na łatwe wyszukiwanie fragmentów kodu, które zostały przez ciebie przeświecone i do których chcesz wrócić. Możesz przeprowadzić wyszukiwanie „TODO” z rozróżnianiem wielkości liter, aby natychmiast znaleźć to, co wcześniej pomijałeś.

„todo” (małe litery) może potencjalnie być częścią większego słowa / funkcji / zmiennej, ale „TODO” (wielkie litery) prawdopodobnie nie będzie.

— Buttle Butkus
źródło

4

Pozwala także redaktorom na zaznaczenie tego. gedit robi to na przykład i robi to tylko dla wielkich liter TODO. Bez względu na przyczynę, to wystarczająca zachęta, abym napisał to wielkimi literami.

4

@delnan: To tautologia. Zostało to zrobione, aby się wyróżniać, więc ludzie go używali, więc ktoś dodał vim, aby wyróżnić się bardziej, więc ludzie używają go, aby się wyróżniać. Ludzie go nie używają, ponieważ edytor wyróżnia go, używają go, ponieważ jest to powszechne, a zatem edytor wyróżnia go. Możesz wyróżnić wszystko w vimie, po prostu odpowiednio zmieniając podświetlanie składni. Równie łatwo jest todowyróżnić się, ale nie ma to większego sensu, ponieważ konwencja polega na użyciu TODO.

— Martin York,

1

@LokiAstari: Jak powiedziałem, I dla jednego przeliterować wielkimi literami, ponieważ więcej redaktorzy podkreślić, że domyślnie. Ale być może jestem wyjątkiem: całkiem młody (więc nie mogłem tego zrobić, zanim redaktorzy go poparli) i (niestety) za dużo kaprysu i leniwego bumu, aby ręcznie dostosować podświetlanie składni.

Przyjemny również dla biednego faceta, który musi za tobą posprzątać, i dla każdego, kto musi przejrzeć twój kod, zanim będzie gotowy. Widzą na pierwszy rzut oka, co jeszcze nie zostało zrobione z powodu tej konwencji.

— sq33G

2

Napotkałem TODO o różnej wielkości liter w nazwie zmiennej jak filesToDownload. Oczywiście wyszukiwanie „tylko całe słowa” rozwiązuje ten problem.

— dan04

8

Jestem ciekaw, kiedy to się zaczęło i czy istnieje powód, by pisać cały kapitał?

Pomysł z komentarzami takimi jak TODO i FIXME polega na tym, aby się wyróżniały. Zasadniczo nie chcesz wysyłać kodu zawierającego takie znaczniki w kodzie - zaznaczają one rzeczy do zrobienia, zanim projekt zostanie uznany za ukończony. Używanie WSZYSTKICH CAPSÓW czyni je trochę łatwiejszymi do zauważenia, pod warunkiem, że WSZYSTKIEGO CAPSA nie używasz również do wielu innych rzeczy w kodzie.

— Caleb
źródło

5

Zarówno Eclipse, jak i Visual Studio mają funkcje Listy zadań, które automatycznie wyświetlają listy linii komentarza, które zawierają TODO.

— O. Jones
źródło

Program Visual Studio zaczął robić komentarze // TODO: po pierwszym dodaniu generatorów kodu dla elementów typu MFC. To była wersja 2.0, iirc.

— mjfgates,

przynajmniej w Visual Studio to wyszukiwanie nie rozróżnia wielkości liter - przyciągnie // todo foo do listy zadań

— jk.

4

Po prostu się wyróżnia i łatwo go złapać ... nic skomplikowanego!

— bunglestink
źródło

1

to i jest łatwe do znalezienia przez grep lub tym podobne

— Zachary K

@ZacharyK: Dokładnie!

— Dynamiczny

1

Zwraca uwagę na fakt, że istnieje todo.

Ważne jest, aby przez cały czas było oczywiste, że ktoś musi wrócić do kodu. Dane muszą być znane tylko osobie, która wraca, aby rozwiązać każdy problem.

— yfeldblum
źródło

1

Jeśli jesteś użytkownikiem vi, użyj:

/DO ZROBIENIA

Zapewni ci to bardzo szybko.

— ncmathsadist
źródło

Inni redaktorzy mają funkcje wyszukiwania i równie łatwo możesz wyszukać todo .

— Karlson,

Z wyjątkiem „todo” może występować w czymś innym, jak nazwa zmiennej lub inny tekst komentarza ...

— sevenseacat

1

vi rozróżnia małe i wielkie litery. Ponieważ ograniczenia są używane oszczędnie w większości współczesnych języków (np. W nazwanych stałych), wyszukiwanie ma duże prawdopodobieństwo powodzenia.

— ncmathsadist

1

Niektórzy redaktorzy podkreślają tylko elementy DO ZROBIENIA, więc bezpieczniej jest zawsze używać wielkich liter.

— Tim Abell
źródło

0

Wizualnie WSZYSTKIE CZAPKI wyróżniają się, ale nie są zbyt czytelne. Podczas odczytu kodu skanują jako blok o określonym rozmiarze. Tak naprawdę nie ma znaczenia, jakie są litery. Wyróżniają się i można je bardzo szybko zobaczyć. Po pewnym czasie pracy z tagami mózg rozpozna słowo po kształcie.

Z punktu widzenia narzędzi (IDE / Editor) wyszukiwanie z rozróżnianiem wielkości liter będzie miało bardzo niski współczynnik fałszywie dodatnich wyników we wszystkich wersjach wielkich liter. W niektórych stylach kodowania istnieje niewielkie ryzyko, że zostanie dopasowana stała. Wyszukiwanie całego słowa z rozróżnianiem wielkości liter sprawia, że fałszywe trafienia są jeszcze mniej prawdopodobne.

Gdy narzędzie pojawi się na ekranie, format wyraźnie mówi: spójrz TUTAJ. Gdy skupisz się na lokalizacji, czytelną częścią będzie powiązany komentarz.

— BillThor
źródło