주석
코드를 이해하고 유지보수하는 데 도움이 되는 중요한 도구.
소스코드안에 있어도 영향이 없는 설명문.
컴파일할 때 주석은 자동으로 바이너리 코드에서 제거되서 프로그램 수행하는데 영향이 없다.
한줄 주석 or 라인 주석
// 이게 바로 한줄 주석이다
Java
복사
블록 주석
/* 이게 바로 블록 주석이다 */
Java
복사
문서 주석
/**
* 이게 바로 문서 주석이다
* @param args Arguments
*/
/**
* @author
* 이게 바로 문서 주석이다
*
*/
Java
복사
언제 사용하는게 좋을까?
1.
코드 설명:
•
코드가 어떤 일을 수행하는지 또는 특정 작업을 왜 수행하는지 설명할 때 사용.
•
다른 개발자나 나중에 자신이 코드를 읽을 때 이해를 줌 (그치만 소스만 봐도 충분히 이해가는 정도면 최대한 안적는게 좋다)
2.
복잡한 알고리즘:
•
복잡한 알고리즘이나 로직을 구현한 경우, 주석을 사용하여 알고리즘의 동작 방식이나 각 단계의 목적을 설명.
3.
임시적인 코드:
•
개발 중인 코드가 아직 완성되지 않았거나 임시적으로 사용되는 경우, 주석을 사용하여 이를 명시할 수 있음.
4.
버그나 이슈:
•
코드에 버그나 이슈가 있는 경우 해당 위치에 주석을 추가하여 다른 사람들에게 알린다. 또한 이러한 주석을 통해 이후에 버그를 수정하는 데 도움이 될 수 있음.
5.
라이선스 및 저작권 정보:
•
코드의 소유권, 라이선스 정보 등과 같은 법적인 문제에 관련된 정보를 주석으로 추가할 수 있다.
6.
그 외
•
개발 서버 및 스테이징 서버에서만 진행하는 별도의 테스트가 생길때 다른 개발자와의 테스트 충돌이 날 수 도 있기 때문에 미리 그에 대한 주석을 추가하고 해당 브랜치에 머지해주자.
내가 속해 있는 프로젝트에서는 파일 상단에 최초 생성자 및 변경이력 등등 작성하는 블럭 주석이 있는데 옛날 방식의 주석이다. 지금은 Git으로 변경이력을 볼 수 있기 때문에 변경이력을 적는 일은 굳이 필요없다.
그리고 최대한 소스 설명에 대한 주석은 안쓰는게 좋다!
어차피 코딩을 잘했다면 굳이 소스에 대한 설명은 필요없을거다…(ㅎㅎ)
주석 가이드라인
•
코드의 의도를 설명하고, 코드 자체가 아닌 '왜' 를 설명.
•
주석은 코드를 보충하고 도움을 주는 것이며, 코드 자체로 설명될 수 있는 내용은 주석으로 작성하지 않는다.
•
코드 변경 시 주석도 함께 업데이트!!!! 주석이 잘못된 정보를 제공하면 오히려 혼란을 야기할 수 있다.
•
주석을 지나치게 남용하지 않고, 가독성을 해치지 않는 선에서 사용.
결론적으로, 주석은 코드를 이해하고 유지보수하는 데 도움을 주는 중요한 도구이다.
적절하게 사용하여 코드의 가독성과 이해도를 향상시키는 데 도움이 되며, 팀원들과의 협업에도 큰 도움이 된다.
