먼저 코딩과 코딩을 수행하는 동안 주석을 달고 논평하는 코드

Question

주석을 쓰는 동안 주석을 쓰거나 쓰는 것에 대한 논쟁과 나중에 모든 주석을 쓰는 것에 대한 반증은 무엇입니까? 코드를 작성하기 전에 주석을 작성하는 것은 어떻습니까?

Answer 1

필자는 코딩하는 동안 주석을 쓰는 것이 중요하다고 생각하지만, 나중에 다시 돌아가서 내용을 명확히하는 것을 배제해서는 안됩니다. 당신은 아마 돌아 가지 않을 나중에 그것을 할

• 코딩하면서

  는 의견을 작성.

• 당신이 한 일을 왜했는지 기억하지 못할 것입니다.
• 기술이나 알고리즘을 연구해야한다면 "소스를 인용"하는 것이 좋습니다.

쓰기 의견

• 를 코딩 한 후에는 아마도 부분은 매우 명확하지 않다 어떤에 더 많은 통찰력, 새로운 관점에서의 코드를 찾고있을거야.

Answer 2

명백한 진술은 삭제되기 전에 나타냅니다.

이
2. 셀프 혼란

같은 루프와 다른 개발자가 코드를 이해 할 수 없습니다 기능의 고급 algothyms 같은 복잡한 코드의 코드 청크의 목적을 잊어 버려 - 나중에 자신을 포함을 사용법에 관해서 또한 메모리를 차지합니다. 성능 향상을 원할 때 수행 할 수 있음

Answer 3

설명 대신 변수, 클래스 , 방법 등

대부분의 상황에서 주석 대신 코드의 의도를 문서화하는 테스트를 선호합니다.

코멘트는 작성 즉시 '코드와 동기화'문제를 만듭니다.

많은 논평을하곤했습니다. 이제 나는 전혀 코멘트를 사용하지 않는다. 그렇다면 대개 명확하지 않은 비정상적인 가장자리 사례 또는 상당히 모호한 이유로 리팩토링하지 않아야하는 코드에 대해 필요합니다.

Answer 4

DURING.

코드의 모든 행은 이며,을 쓰는 것이 가장 좋습니다.