MoinMoin   주석 UserPreferences
 
Help Info Print View Search Diffs Edit
 인덱스   도움말   찾기   대문   바뀐글 
  1. 목적
  2. 주석
  3. 관련 서적
  4. 관련 사이트
Since 2009. 10. 29.

목적

주석

대학시절 프로그래밍 과제에서 좋은 성적을 받기 위해서는 되도록 많은 주석을 달아야 했다.
10줄 내외의 함수에 대해서도 상세하게 주석을 달면 좋은 성적을 주었다.
'주석이 없는 코드는 악이다.'라는 식이다.

회사에서도 개발일을 하다보면 비슷한 상황을 만난다.
'뭐야 주석도 없고...'
'주석이 없어서 분석하는데 시간이 오래 걸립니다.'
많은 개발자가 주석이 있는 코드는 좋은 코드라는 등식을 성립시킨다.

꼭 필요할 경우에만 사용하고 가급적 사용하지 말자!

주석이 있다는건 코드만으로는 이해하기 어렵다는 뜻이 아닐까?

    특히 method, class, 변수명에 대한 설명을 주석으로 처리하는 것은 명백한 중복이다.
ex)
String a; //사용자의 이름으로 사용할 변수
a = "Shin"; //이름으로 사용할 변수에 Shin을 대입한다.

중복은 관리에 2배의 노력이 든다.

    소스 코드 하나도 깨끗하게 정리하고 유지하기 힘든데 어찌 주석까지 관리가 될까?

코드에 주석 녹여내
    제대로된 naming은 코드가 사용되는 동안 제 값을 다한다. 더 자주 사용되고 더 잘 괸리된다. (2004년 작성한 코드가 아직까지도 불만 없이 사용되더라.)

나의 경험 :
하나의 method가 여러가지 목적으로 사용하여 추상적인 이름을 붙여하는 하는 경우가 많더라.
method이름으로 Process, Do 등등 구체적이지 않은 이름을 사용하는 경우 method의 사이즈가 엄청 커지고 정말 많은 일을 하더라.
method와 주석이 전혀 다른 경우도 많더라. 처음 주석 작성 후 method가 하는 일이 바뀌거나 인자가 바뀌었지만 주석은 그대로 남아 있는 경우가 많더라.

관련 서적

관련 사이트

PythonPowered EditText of this page (last modified 2009-10-29 16:15:31)
FindPage by browsing, searching, or an index
Or try one of these actions: DeletePage, DeleteUploadedFile, LikePages, SpellCheck, UploadFile