// 비밀번호 찾기 요청 처리 함수
const handleFindPw = async (values) => {
// ...
};자바스크립트를 이렇게 써본적이 있었던가......
최근 진행중인 사내 프로젝트에서 자바스크립트를 굉장히 많이 사용하고 있어서, 어떻게 주석을 남겨야할 지 고민이 되었다.
1. JSDoc 스타일
/**
* 사용자의 비밀번호 찾기 요청을 처리한다.
* @param {Object} values - 폼에서 입력된 값들
* @param {string} values.email - 사용자 이메일
* @returns {Promise<void>}
*/
const handleFindPw = async (values) => {
// ...
};
2. 간단한 설명만 필요한 경우
// 비밀번호 찾기 요청 처리 함수
const handleFindPw = async (values) => {
// ...
};
3. 함수 선언식 (function)
/**
* 두 숫자를 더한다.
* @param {number} a
* @param {number} b
* @returns {number}
*/
function add(a, b) {
return a + b;
}
VS Code를 사용한다면, 아래와 같은 방법으로 주석을 남길 수 있다.
1. 주석을 달고 싶은 함수 위에 커서를 올린다.
2. /** 를 입력하고 Enter 를 누르면 VS Code가 자동으로 JSDoc 템플릿을 생성해준다.
이대로도 편하지만(?) 귀찮음이 많은 나는 VS Code의 확장 프로그램을 찾아보기로했다.
1. 사이드바에서 확장 클릭 또는 Ctrl + Shift + X
2. Document this 검색 후 설치
3. 함수에 커서를 올리고 Ctrl + Alt + D → Ctrl + Alt + D
- Windows : Ctrl + Alt + D → Ctrl + Alt + D
- Mac : Cmd + Alt + D → Cmd + Alt + D
그럼 아래와 같이 주석이 작성된다.
뭔가 좀 이상한 것 같지만...? 다른 함수에도 사용해봐야겠다.
