2015년 06월 17일 이펙티브자바 스터디.

스터디 범위 : 이펙티브 자바 규칙17.

   참여인원 : 총 5명 - 테리팍, 호이루팍, 빅터신, 지니유, 아론킴

상속을 위한 설계와 문서를 갖추거나 그럴수 없다면 상속을 하지말라!??

재정의 기능 메소드를 내부적으로 어떻게 사용하는지(self-use) 반드시 문서에 남기라는 것.

 - 더 쉽게 풀어서 말하면 메소드 내부동작 원리에 관한 주석을 남기라는 뜻.

토론) java doc 이야기

테리팍 : java doc을 남기는 것은 좋은 것 같다.

• 이유 : 이력관리도할 수있고, 더 나아가 CI서버에서도 사용할 수 있다. 또한 개발 전후에 유용할 것 같다.

호이루팍 외 3명 : 이력은 커밋로그나 히스토리를 통해서 보면 되지 않는가? java doc은 관리가 안된다.

빅터신 : 주석(java doc)은 필요한 것만 즉, 메소드명등으로 한번에 파악하지 못할 것들에 대해서

테리팍 : 동의. 이력관리 이야기는 확장성을 위해 말함. 프로젝트 들어가기전에 빅터신이 말한 것처럼 업무적인 요소나 특이사항을

            자바doc이나 주석으로 남기면 좋을 것 같다.

개발자는 코드로 말하는것이 제일 좋다고는 생각하지만 서로의 생각이 많이 상이하기때문에 히스토리성이나 업무성 특이사항은

공유할 수 있도록 java doc, 소스주석, 위키등으로 약속된 관리가 필요할 것 같다.