주석의 경우 재량으로 두고 있으나, IDE에서 인식할 수 있는 /** */ 형태 및 @param 등의 문법으로 유용한 주석을 작성할 수 있도록 노력합니다.
기획과 관련되지 않아도 코드에 주석이 필요한 경우가 있습니다. 최적화를 위해 가독성이 낮은 알고리즘을 사용하거나, 특정 기술적 이슈 때문에 일반적으로는 이해하기 어려운 처리를 해야 하는 경우 등이 이에 해당합니다.
주석 관리
속성
기본 Domain 구성 가이드
답변 완료 여부 또는 인지 여부
질문 또는 인지 이유
특별한 케이스가 아닌 경우, 주석을 작성해놓지 않아도 코드만 보고 이해할 수 있도록 짜야합니다.
여기서, 특별한 케이스란 코드를 파악하기 위해 “기획”을 알아야하는 부분을 뜻합니다. 그 외에는 코드만 보고 이해할 수 있어야합니다.