Javascript의 주석

안녕하십니까?

자, 저는 개발자가 싫어하지만 개발 수명 주기에서 매우 중요한 부분인 또 다른 주제를 가지고 돌아왔습니다.

당신은 그것을 맞혔습니다 (분명히 제목 😛에서).

예, 코드의 주석

때때로 금요일에 작성하는 코드가 월요일에 이해가 되지 않기 때문에 필요합니다. 😂️

자, 다시 주제와 심각성으로 돌아오겠습니다🙈️

그래서 내가 왜 그것에 대해 큰 소란을 피우고 있습니까?

여러 함수와 API를 작성했다고 가정합니다. 지금 바로 사용하거나 팀원에게 전달할 수 있습니다. 당신이 지금 그것을 쓴 것처럼 당신의 마음 속에 모든 것이 분명합니다. 하지만 당신이 그것을 전달하는 당신의 동료, 또는 당신의 미래의 자신도 그것이 무엇을 하는지 기억하지 못할 것입니까?

좋은 ReadMe, 방법 안내 및 코드의 주석이 이러한 질문을 해결합니다. 오늘 우리의 초점은 댓글

입니다.

Good code is self-documenting.

주석을 사용하여 코드를 문서화하면 몇 개월 동안 작성한 코드를 이해하는 데 도움이 될 뿐만 아니라 팀의 다른 구성원에게도 도움이 됩니다.

두 가지 유형의 주석을 사용할 수 있습니다.

설명서 주석에는 파일에 대한 정보, 함수가 수행하는 작업이 포함됩니다.

기능 주석에는 매개변수, 해당 데이터 유형, 설명 및 반환 값이 포함됩니다.

코드 블록을 설명하는 한 줄 주석을 추가할 수도 있습니다.

의견을 추가하는 방법?

이제 코드에 어떤 종류의 주석을 추가하느냐가 정말 중요합니다. 직접적이고 설명적이며 표준화되어야 합니다. 그렇지 않으면 시끄럽고 읽기 어려워집니다.

잘 관리되는 표준 도구 중 일부는 Javascript용 JSDoc, .NET용 DocFx 및 Java용 JavaDoc입니다.

Javascript에 대해 이야기하는 것처럼 js용 Vscode - 주로 사용되는 IDE에는 js 파일용 JSDoc 지원이 내장되어 있습니다.

설명서 주석
다음은 파일 문서에 파일 수준 주석을 추가하는 방법입니다.

/**
 * filename.js
 * Description: It's basic Description.
 */

예시:

기능 설명

/**
* Function-name : Brief Description
* @param {Datatype} Name : Brief Description
* @return {array}
*/

예시:



다음은 JSDoc의 치트 시트입니다. https://devhints.io/jsdoc

어떻게 도움이 되나요?

이제 함수를 호출할 때마다 해당 함수를 직접 작성할 수도 있고 다른 사람이 작성할 수도 있습니다. 당신은 아마 그것이 무엇을 하는지 알고 있지만 반드시 이러한 질문을 갖게 될 것입니다.

어떤 매개변수를 사용합니까?

반환 값은 무엇입니까?

매개변수 및 반환 값의 데이터 유형은 무엇입니까? 등

이제 매직을 만나보세요! 🪄

randomNumber 함수에 주석을 추가했으므로 이제 호출합니다.



randomNumber()를 호출하는 블록을 볼 수 있습니다. 주석으로 인해 생성됩니다.

방법이 하나 더 있습니다😉️. 함수 위로 마우스를 가져가면 해당 데이터 유형과 함께 해당 설명, 매개변수 및 반환 값을 볼 수 있습니다.



오늘은 여기까지입니다.
코드 문서화의 중요성을 이해하시기 바랍니다.
이 블로그에도 댓글을 달아주세요. 😄️ 그리고 당신의 생각을 알려주세요.

나에 대해서:

저는 DhiWise의 Nodejs 개발자입니다. 6가지 기술에 대한 프로덕션 준비 코드를 생성하는 프로 코드 devtool입니다. Check it out 기술광이라면 😋️
당신은 나를 찾을 수 있고 우리는 내가 개발하고 있는 것과 같은 멋진 devtools에 대해 이야기할 수 있습니다.
계속 코딩하고👩‍💻️, 계속 문서화하세요. 안녕히 계세요. 👋️