#주석!!!
<!--주석-->
😎
코드를 분석하고 쉽게 이해하기 위해 주석을 사용하게 된다.
이러한 주석은 본인과 협력하는 개발자들을 위해 효율적으로 작성되어야 한다.
1. 코드의 목적과 의도를 담아 설명해야한다.
2. 코드의 단순 기능을 작성하는 것이 아닌 코드 작성에 대한 이유를 포함해야한다.
3. 제약조건 등을 포함하여 수정 시 참고할 수 있도록 한다.
4. 코드 변경 이력 내용을 주석에 포함하여 남기는 것도 협업을 하는 경우 도움이 될 수 있다.
5. 적절한 주석의 사용
-필요한 경우에만 핵심내용만 포함하여 간결하게 주석을 남기는 것이 효율적이다.
효율적이고 올바른 주석 사용을 통해 개발 업무 효율을 높이자!
'Development > IT' 카테고리의 다른 글
| Chat GPT 확장 프로그램 사용 (0) | 2023.04.07 |
|---|
