Study/TIL

[TIL] 주석 컨벤션

코딩 컨벤션이란? 그리고 주석 컨벤션? 코딩 컨벤션? - 읽고, 관리하기 쉬운 코드를 작성하기 위한 일종의 코딩 스타일 규약이다. 주석 컨벤션? - 위에서 나오는 코딩 컨벤션의 일종으로 협업을 위한 주석을 처리하는 경우에 파일에 삽입하거나 로직 중간에 삽입할 주석의 형태나 모양, 주제 혹은 카테고리를 정하여 코딩하는 주석 스타일 규약이다. 코드 컨벤션의 장점 코딩 컨벤션을 준수하면 가독성이 좋아지고, 성능에 영향을 주거나 오류를 발생시키는 잠재적 위험 요소를 줄여준다. 특히 규모가 큰 프로젝트일수록 유지보수 비용을 줄이는 데 도움이 된다. 주석 컨벤션 (여러 컨벤션 중 일부) 1. 주석은 설명하려는 구문에 맞춰 들여쓰기 한다. function someFunction() { // statement에 관한 ..