개발 다이어리

대다수의 주석이 이 범주에 속한다.

허술한 코드를 지탱하거나, 엉성한 코드를 변명하거나, 미숙한 결정을 합리화하는 등

주절거리는 주석

특별한 이유 없이 의무감으로 다는 주석

의미를 파악하려면 결국 코드를 뒤져보는 수밖에 없다.

주석을 달기로 했다면 충분한 시간을 들여 최고의 주석을 달도록 노력한다.

오해할 여지가 있는 주석

의무적으로 다는 주석

모든 함수에 Javadocs를 달거나 모든 변수에 주석을 달아야 한다는 규칙은 어리석기 그지없다.

이런 주석은 코드를 복잡하게 만들며, 거짓말을 퍼뜨리고, 혼동과 무질서를 초래한다.

이력을 기록하는 주석

이력을 관리하는 주석은 없애버리는 게 좋다. 이제는 소스코드 관리시스템이 있기 때문이다.

공로를 돌리거나 저자를 표시하는 주석도 소스코드관리시스템에 맡기는 게좋다.

주석으로 처리한 코드도 소스코드관리시스템에 맡긴다.

있으나 마나 한 주석

쉽게 말해, 너무 당연한 사실을 언급하며 새로운 정보를 제공하지 못하는 주석

이런 주석은 개발자가 주석을 무시하는 습관에 빠지게 할 수도 있다.

있으나 마나 한 주석을 달려는 유혹에서 벗어나 코드를 정리하라.

함수나 변수로 표현할 수 있다면주석을 달지 마라

위치를 표시하는 주석

때때로 프로그래머는 소스 파일에서 특정 위치를 표시하려 주석을 사용한다.

// 수정필요///////////////////////////////////////////

일반적으로 위와 같은 주석은 가독성만 낮추므로 제거해야 마땅하다.

특히, 뒷부분 슬래시(/) 주석은 최악이다.

닫는 괄호에 다는 주석

중첩이 심하고 장황한 함수라면 의미가 있을지도 모르지만,

우리가 선호하는 작고 캡슐화된 함수에는 잡음일 뿐이다.

그러므로 달아야겠다는 생각이 든다면 함수를 줄이려 시도하자

요즘은  IDE가 괄호 파악을 잘해줘서 더욱 불필요할 것

try{
	while(true){
    	...
    }//while 끝
	...
}//try 끝

공로를 돌리거나 저자를 표시하는 주석

소스 코드 관리 시스템은 누가 언제 무엇을 추가했는지 귀신처럼 기억한다.

저자 이름으로 코드를 오염시킬 필요가 없다.

주석이 있으면 다른 사람이 물어볼 수 있으니 유용하다 생각할지 모르겠다.

하지만 현실적으로 이런 주석은 그냥 오랫동안 코드에 방치되어 점차 부정확하고 쓸모없는 정보로 변하기 쉽다.

그냥 소스 코드 관리 시스템에 맡기는 편이 옳다.

주석으로 처리한 코드

주석으로 처리된 코드는 다른 사람들이 지우기를 주저한다.

이유가 있어 남겨놓았으리라고, 중요하니까 지우면 안된다고 생각한다.

결국 쓸모 없는 코드가 점차 쌓여간다.

1960년대 즈음에는 주석으로 처리한 코드가 유용했었다. 하지만 우리는 오래전부터 우수한 소크 코드 관리 시스템을 사용해왔다. 소스 코드 관리 시스템이 우리를 대신해 코드를 기억해준다. 이제는 주석으로 처리할 필요가 없다. 그냥 코드를 삭제하라. 잃어버릴 염려는 없다. 약속한다.

너무 많은 정보

너무 많은 정보를 다는 주석은 않좋다.

모호한 관계

주석과 주석이 설명하는 코드는 둘 사이 관계가 명백해야 한다.

이왕 공들여 주석을 달았다면 적어도 독자가 주석과 코드를 읽어보고 무슨 소린지 알아야 하지 않겠는가?

함수 헤더

짧은 함수는 긴 설명이 필요 없다.

짧고 한 가지만 수행하며 이름을 잘 붙인 함수가 주석으로 헤더를 추가한 함수보다 훨씬 좋다.

비공개 코드에서 Javadocs

공개 API는 Javadocs가 유용하지만 공개하지 않을 코드라면 Javadocs는 쓸모가 없다.

시스템 내부에 속한 클래스와 함수에 Javadocs를 생성할 필요는 없다.

유용하지 않을 뿐만 아니라 Javadocs주석이 요구하는 형식으로 인해 코드만 보기 싫고 산만해질 뿐이다.

주석은 순수하게 선하지 못하다. 주석은 필요악이다.

프로그래밍 언어 자체가 표현력이 풍부하다면, 우리가 치밀하게 프로그래밍하면 안 쓸 수도 있기 때문이다.

주석은 우리가 코드로 의도를 표현하지 못해서 사용하는 것이다.

따라서 주석을 쓰기 전에 코드로 표현할 수 없을 지를 고민하자

주석은 거짓말을 한다. 현실적으로 프로그래머가 주석은 관리하고 최신화하지 않기 때문이다.

따라서 코드가 시간이 지남에 따라 거듭 변경되면 될 수록 코드와 주석은 점점 멀어진다.

아니, 분리된다.

거짓말하는 주석은 없는 주석보다 더 나쁘다.

반면에 코드를 보자, 코드는 항상 진실된 정보만 제공한다.

주석은 나쁜 코드를 보완하지 못한다.

코드에 주석을 추가하는 일반적인 이유는 코드 품질이 나쁘기 때문이다.

표현력이 뛰어나며 주석이 거의 없는 코드가, 복잡하고 어수선하며 주석이 많이 달린 코드보다 좋다.

코드로 의도를 표현하라

// 보너스 받을 자격을 검사한다.
if(employee.performance == "우수" && employee.age <=30)  //이런 것보다.
if(employee.isBenefit())  // 이게 가시성이 우수하다.

좋은 주석

좋은 주석은 글자 값을 한다.

하지만 명심하라! 정말로 좋은 주석은, 주석을 달지 않을 방법을 찾아낸 주석이라는 사실을!

법적인 주석

저작권 정보, 소유권 정보 등은 필요하고 타당한 주석이다.

정보를 제공하는 주석

abstract 메서드의 경우 나중에 구현부가 될 정보를 알려준다.

의도를 설명하는 주석

구현이 조금 복잡하다면 이해를 도와주는 선을 넘어 의도를 설명하는 것도 나쁘지 않다

의미를 명료하게 밝히는 주석

때때로 모호한 인수나 반환값은 그 의미를 읽기 좋게 포현하면 이해하기 쉬워진다.

인수나 반환값 자체를 명확히 하면 좋겠지만,

인수나 반환값이 라이브러리나 변경하지 못하는 코드에 속한다면 의미를 명료하게 밝히는 주석이 유용하다

결과를 경고하는 주석(특히 테스트 케이스에서)

// 테스트 시간이 오래 걸립니다. 주의하세요!
public void _somethingTest(){
....

물론 요즘에는 @Ignore 속성을 이용해 테스트 케이스를 꺼버린다.

구체적인 설명은 @Ignore속성에 문자열로 넣어준다.

@Ignore("실행이 너무 오래 걸린다.")

JUnit4 가 나오기 이전에는 메서드 이름 앞에 _ 기호를 붙이는 관례가 있었다.

TODO 주석

TODO주석은 당장 구현하기 어려운 업무를 기술한다.

예를 들어 누군가에게 문제를 봐달라는 요청, 앞으로 발생할 이벤트에 맞게 고치라는 등등…

TODO주석은 IDE기능을 사용해 주기적으로 검사해서 제거해 나가야 한다.

중요성을 강조하는 주석

정말 중요한 정보를 강조하기 위함

공개 API에서 Javadocs

설명이 잘 된 공개 API는 참 유용하고 만족스럽다.

표준 자바 라이브러리에서 사용한 Javadocs가 좋은 예다.

자바 독이없다면 개발이 어려울 것

이처럼 공개 API를 구현한다면 반드시 훌륭한 Javadocs를 작성한다.