Jak wskazać parametr jest opcjonalny za pomocą wbudowanego JSDoc?

Question

Według wiki JSDoc dla @param można wskazywać na @param jest opcja korzystania

/** 
    @param {String} [name] 
*/ 
function getPerson(name) { 
} 

i można wskazać param inline użyciu

function getPerson(/**String*/ name) { 
} 

I mogę połączyć je jak poniżej, które działa dobrze.

/** 
    @param [name] 
*/ 
function getPerson(/**String*/name) { 
} 

Ale chciałbym wiedzieć, czy istnieje sposób, aby zrobić to wszystko w linii, jeśli to możliwe.

Answer 1

Znalazłem sposób, aby to zrobić za pomocą Kompilatora zamykania Google type expressions. Można umieścić znak równości po rodzaju tak: function test(/**String=*/arg) {}

Answer 2

Po pewnym wykopaniu znalazłem te są w porządku, jak również

/** 
* @param {MyClass|undefined} 
* @param {MyClass=} 
* @param {String} [accessLevel="author"] The user accessLevel is optional. 
* @param {String} [accessLevel] The user accessLevel is optional. 
*/ 

tylko nieco bardziej atrakcyjne wizualnie niż function test(/**String=*/arg) {}

Answer 3

Od official documentation:

Opcjonalny parametr

Opcjonalny parametr o nazwie foo.

@param {number} [foo] 
// or: 
@param {number=} foo 

Opcjonalny parametr foo o wartości domyślnej 1.

@param {number} [foo=1]