주석 표기에 대하여 물어보고 싶어요~

2 년 전

840명이 읽음

/**
 * Make image
 *
 * @param {Object} options
 * @param {Function} callback
 */
function makeImage(options, callback) {}

이런 형식의 주석을 사용하는데 첫번째 인자값이 key:value로 이루어진 오브젝트입니다. 이 오브젝트를 설명하고 싶은데 아직 규칙에 맞는 형식을 못찾았는데요... 어떻게 표현하는게 좋은지 의견을 구하고 싶습니다.

이게 항상 고민해왔던거라서...

* @param {Object} options : {
*    {int} width
*    {int} height
* }

이런 형태는 적절해 보이지도 않아 보이구요...;;;;

RedgooseDev
2 년 전

Comments0

2 Answers

sangjun님이 아래 링크를 알려주셔서.. http://stackoverflow.com/questions/2009122/phpdoc-for-variable-length-arrays-of-arguments

다음과 같은 형태의 주석을 만들어봤습니다.

/**
 * Make image
 *
 * @param {Object} options
 * @param {Object} options.image         image element
 * @param {int}    options.resampleCount 
 * @param {int}    options.width
 * @param {int}    options.height
 * @param {int}    options.cx            crop x
 * @param {int}    options.cy            crop y
 * @param {int}    options.cw            crop width
 * @param {int}    options.ch            crop height
 * @param {int}    options.dx
 * @param {int}    options.dy
 * @param {int}    options.dw
 * @param {int}    options.dh
 * @param {String} options.bgColor
 * @param {Function} callback
 */

괜찮아 보이는 형태라서 이렇게 사용해볼까 합니다. :)

RedgooseDev
2 년 전

Comments0

자바 스크립트 주석을 말씀하시는거죠? 그러면 jsdoc3 쓰세요. http://usejsdoc.org/index.html

linuxwife
2 년 전

Comments0