如何在JSDoc中不重复相同的文本,如C语言中的#define

时间:2019-03-31 17:32:52

标签: jsdoc

定义链接时,我必须重复多次相同的文本。 例如:
链接是{@link Parameter / peso / tiesto / casero〜parametro.html#.isReal}
{@link Parameter / peso / tiesto / casero〜parametro.html#country}

在文件开头声明#define之类的内容应该很方便:
#定义地址“ Parameter / peso / tiesto / casero〜parametro.html”

接下来,我可以填充较短的链接,例如:
{@link address#.iisReal}
{@link address#country}

1 个答案:

答案 0 :(得分:0)

感谢您的评论。 Graham P. Heath
实际上,我使用的是您提供的链接中所述的降价标记。但是,我在同一文件中多次重复同一链接。 例如:

setwd("path")
check("my_package")
install("my_package")
library("my_package")
trivial_function(2,3)

/** * Method to do something [XXX][1] object from a `lwParR` JSON string. * * [1]: module-ppp_kkk-XXX.html * * @param {string} - [XXX][1] JSON string * * [1]: module-ppp_kkk-XXX.html * * @returns {number} [XXX][1] object. * * [1]: module-ppp_kkk-XXX.html * */ ,第一个description和第二个@param是不同的块,降价标记法仅对一个块有效。