Clean Code that Works.

그냥 주석 -ㅂ -..

Java2008. 8. 1. 10:13
/**
 *
 *
 */

이런 형태의 주석... 이거 이름이 따로 있었던거 같은데..
여튼 요즘엔 코딩 하면서 클래스나 메서드 앞에는 꼭 저걸 붙여서 설명을 달아 둔다.
나중에 확인해야 할것도 있고 혹시 다른 사람이 내 코드를 볼 것을 대비해서.

이클립스에서는 /** 이렇게 하고 엔터를 치면 자동으로 파라미터 라던지 메서드나 클래스에 대한 정보를 생성해준다. 유저는 그냥 거기옆에다가 설명을 적어 주기만 하면 되고..
이렇게 만들어 주면 유지 보수에도 좋지만 나중에 메서드를 사용할 때 코드 어시스트를 보면 메서드에 대한 설명까지 같이 나오기 때문에 참 좋다.

사용자 삽입 이미지

이런 형식으로 사용하거라~!