모두가 왜해야 할 일을 대문자로 쓰나요? [닫은]


9

나는 똑같이하고 있습니다. 내 코드에 "해야 할 일"이 있으면을 작성 //TODO ...합니다. 그러나 이것이 언제 시작되었고 모든 대문자로 "해야 할 일"을 쓰는 이유가 있는지 궁금합니다.


20
우리가 정말 그런 뜻이 있기 때문에 (우리는 단지 실제로 주위에 결코)
앤서니 Pegram

3
편집자들이 그것들을 표시하고 그것들을 검색하도록 할 수 있습니다 (예를 들어 이클립스의 작업 목록)
ratchet freak

6
실제로 코드 내에서 텍스트를 굵게 표시 할 수 없으므로 중요한 것을 눈에 띄게하는 방법이 필요했습니다. 따라서 ...
Karlson

4
왜 중요한가요?
Rook

3
내가 쓴//todo:...
BЈовић

답변:


23

또한, 글을보고 다시 돌아 가려는 코드 섹션을 쉽게 검색 할 수있는 방법이 좋습니다. 대소 문자를 구분하여 "TODO"를 검색하면 이전에 건너 뛴 내용을 즉시 찾을 수 있습니다.

"todo"(소문자)는 잠재적으로 더 큰 단어 / 함수 / 변수의 일부일 수 있지만 "TODO"(대문자)는 그렇지 않을 것입니다.


4
또한 편집자가이를 강조 할 수 있습니다. 예를 들어 gedit는 모든 대문자에 대해서만 수행합니다 TODO. 이유가 무엇이든 대문자로 쓰면 충분합니다.

4
@delnan : 그것은 팽팽한 기술입니다. 그것은 사람들이 그것을 사용하기 위해 만들어 졌기 때문에 누군가가 vim에서 구문 강조를 추가하여 더 두드러지게 만들었습니다. 그래서 사람들은 그것을 강조하기 위해 그것을 사용합니다. 편집자가 눈에 잘 띄게하기 때문에 사람들은 그것을 사용하지 않습니다. 평상시처럼 사용하기 때문에 편집자가 눈에 띄게 만듭니다. vim에서 무엇이든 눈에 띄게 만들 수 있습니다. 구문 강조 표시를 적절하게 변경하면 todo눈에 띄는 것처럼 쉽지만 관습이 TODO를 사용한다는 점은 거의 없습니다.
Martin York

1
@LokiAstari는 :만큼 나는 말했다 I을 더 편집자는 기본적으로 그것을 강조하기 때문에 하나의 수도에서 철자를 위해. 그러나 아마도 예외입니다. 아주 젊어서 ( 편집자가 지원하기 전에는 할 수 없었 습니다) 구문 슬프게 수동으로 조정하기에는 너무 슬프고 게으른 부랑자입니다.

또한 당신을 청소 해야하는 가난한 사람과 코드가 완성되기 전에 코드를 살펴야하는 사람에게도 좋습니다. 이 컨벤션으로 인해 아직 수행되지 않은 작업을 한 눈에 볼 수 있습니다.
sq33G

2
와 같은 변수 이름에서 대소 문자가 혼합 된 TODO가 발생했습니다 filesToDownload. 물론 "전체 단어 만"검색으로 문제가 해결됩니다.
dan04

8

이것이 언제 시작되었고 할 일을 모두 대문자로 쓸 이유가 있는지 궁금합니다.

TODO 및 FIXME와 같은 의견이있는 아이디어는 의견을 고수하는 것입니다. 일반적으로 코드에 이러한 마커가있는 코드를 제공하고 싶지는 않습니다. 프로젝트를 완료하기 전에 수행해야 할 작업을 표시합니다. 모든 CAPS를 사용하면 코드에서 다른 많은 항목에도 ALL CAPS를 사용하지 않는 경우 좀 더 쉽게 찾을 수 있습니다.


5

Eclipse와 Visual Studio에는 모두 TODO가있는 주석 행 목록을 자동으로 제공하는 작업 목록 기능이 있습니다.


Visual Studio는 MFC 보일러 플레이트 용 코드 생성기를 처음 추가 할 때 // TODO : 주석을 시작했습니다. 그것은 버전 2.0, iirc였습니다.
mjfgates

적어도 Visual Studio의 경우이 검색은 대소 문자를 구분하지 않습니다. // todo foo를 작업 목록으로 가져옵니다
jk.

4

난 그냥 눈에 띄고 잡기 쉽습니다 ... 아무것도 복잡하지 않습니다!


1
그리고 grep 등을 통해 쉽게 찾을 수 있음
Zachary K

@ZacharyK : 맞아요!
Dynamic

1

그것은 거기 있다는 사실에주의를 환기 존재 할 일을.

누군가 코드를 다시 작성해야한다는 것이 항상 분명해야합니다. 문제는 무엇이든지 문제를 해결하기 위해 돌아 오는 사람 만 알면됩니다.


1

vi 사용자 인 경우 다음을 사용하십시오.

/할 것

그것은 매우 빨리 당신을 얻을 것입니다.


다른 편집기에는 검색 기능이 있으며 todo 를 쉽게 검색 할 수 있습니다 .
Karlson

'todo'를 제외하고 변수 이름이나 다른 주석 텍스트와 같은 다른 곳에 나타날 수 있습니다.
sevenseacat

1
vi는 대소 문자를 구분합니다. 대부분의 현대 언어 (상수 상수와 같은 언어)에서는 대문자를 거의 사용하지 않기 때문에 검색 가능성이 높습니다.
ncmathsadist

1

일부 편집기는 대문자 TODO 항목 만 강조 표시하므로 항상 대문자를 사용하는 것이 안전합니다.


0

시각적으로 모든 CAPS가 눈에 띄지 만 읽기 쉽지는 않습니다. 코드를 읽을 때 특정 크기의 블록으로 스캔합니다. 글자가 무엇인지는 중요하지 않습니다. 그들은 눈에 띄고 매우 빨리 볼 수 있습니다. 한동안 태그로 작업하면 뇌는 단어를 형태별로 인식합니다.

도구 (IDE / Editor) 관점에서 대소 문자 구분 검색은 모든 대문자 버전에서 오 탐지율이 매우 낮습니다. 일부 코딩 스타일에서는 상수가 일치 할 위험이 적습니다. 대소 문자 구분 전체 단어 검색은 오 탐지 가능성을 줄입니다.

도구가 화면에 표시되면 형식은 명확하게 여기를 나타냅니다. 위치에 초점을 맞추면 읽기 쉬운 부분이 관련 설명이됩니다.

당사 사이트를 사용함과 동시에 당사의 쿠키 정책개인정보 보호정책을 읽고 이해하였음을 인정하는 것으로 간주합니다.
Licensed under cc by-sa 3.0 with attribution required.