JavaScript의 @Param 태그

이 기사에서는 JavaScript 소스 코드에서 @param 태그를 배우고 사용합니다. 이 태그는 소스 코드의 문서화에 사용됩니다.

이러한 유형의 태그는 프로그래머가 코드의 실행 흐름을 이해하는 데 유용합니다.

JavaScript의 @param 태그

JavaScript 소스 코드 문서에서 @param 태그는 이름, 유형 및 설명과 같은 기능 매개변수의 다양한 세부 정보를 제공합니다. @param 태그는 기능 매개변수에 대한 설명과 함께 표시됩니다.

@param 태그를 분리하면 세 부분으로 나뉩니다.

1. 첫 번째는 매개변수의 데이터 유형을 정의하는 데 사용할 수 있는 중괄호 {} 안에 있습니다.
2. 두 번째는 매개변수의 이름입니다.
3. 마지막 부분은 하이픈 - 기호로 구분된 매개변수 설명입니다.

@param의 기본 구문:

/**
 * @param {data type of param} param name - description of param.
 */
function functionName(paramName) {
  alert('Hello ' + paramName);
}

@param 태그를 사용하려면 개발자가 표준에 따라 매개변수 세부정보를 정의해야 합니다. 이러한 표준에 따라 매개변수 설명을 제공하면 JavaScript 문서 주석을 더 읽기 쉽고 이해하기 쉽게 만들 수 있습니다.

매개변수는 내장 JavaScript 유형일 수 있습니다. 문자열 또는 개체일 수 있습니다.

속성이 있는 매개변수

매개변수가 특정 속성을 가질 것으로 예상된다고 가정합니다. 추가 @param 태그를 사용하여 문서화할 수 있습니다. 학생 매개변수에 이름과 클래스 속성이 포함되어 있으면 아래와 같이 문서화할 수 있습니다.

<script>
/**
 * Assign the class to the student.
 * @param {Object} student - The student who is a part of class.
 * @param {string} student.name - The name of the student.
 * @param {string} student.class - The student's class.
 */
function studentData(student) {
    // rest operation of function
};
</script>

콜백이 있는 매개변수

매개변수가 콜백 함수를 허용하는 경우 @callback 태그를 사용하여 콜백 유형을 정의할 수 있습니다. 그런 다음 아래와 같이 @param 태그에 콜백 유형을 포함할 수 있습니다.

<script>
/**
 * @callback callbackRequest
 * @param {number} statusCode
 * @param {string} message
 */

/**
 * asynchronous task and on completion executes the callback.
 * @param {callbackRequest} callBack - The callback for handle the result.
 */
function asynchronousTask(callBack) {
    // rest operation of function
};
</script>