使用外部文档扩展JSDoc

时间:2015-09-01 10:35:45

标签: javascript documentation documentation-generation jsdoc

是否可以使用外部文档扩展JSDoc? 我的问题是,通过在.js文件中写入所有文档,大小变得越来越大,这对代码的可读性不利。我还想在文档中添加一些示例。在JSDoc我只找到添加链接,但那不是我想要的。

一个例子:

/** 
*Bla bla bla
* 
* para1= ...
* 
* {@LINK_TO_EXTERNAL_DOC@}
* {@LINK_TO_EXTERNAL_EXAMPLES@}
*/

通过生成文档,外部文件的内容应该是"内联"并且在没有链接的情况下打印在文档中。

由于

0 个答案:

没有答案