http://java.sun.com/j2se/javadoc/writingdoccomments/

자바로 개발하다 보면, 주석을 잘 정리하지 않는 경우가 있는데
-나중에 내가 이 메소드를 왜 만들었는지,
-무슨 역할을 하는 클래스인지
를 기억 못하는 경우가 종종 있다.

그리고 추후에 Java doc 문서를 만들때 필요한 요소들을 모르면 제대로 된 문서가 생성되지 않는다.

위에 있는 링크를 참조하여, 반드시 자신의 클래스에 주석을 다는 버릇을 들이자.
특히 이 버릇은 정말 고치기 힘들다.

참고로 eclipse에서는 comment를 달기 위해서 해당 메소드나 클래스의 블록 안에서 Alt+Shift+J 를 누르면, 기본적인 주석이 생성된다.

public class A {
  //지점 1
  public void methodB () {
    //지점 2
  }
}

즉 지점 1에서 단축키를 누르면 클래스의 주석이 자동 생성되고,
지점 2에서 단축키를 누르면 메소드의 주석이 자동 생성된다.
Posted by tuning-java