我目前正在使用node.js建立一个网上商店,并且我想包含几乎所有我注释过的javascript代码的文档。我可以使用JSDoc轻松创建文档并创建漂亮的html文档,但这不是我想要的。
我想在我的网站中创建一个导航,其中文档已集成到我的spa中。因此,我进行了一些研究,发现了一些jsdoc-x之类的npm模块,它们基于JSDoc注释创建JSON,但是它很神秘,很难创建适当的文档。使用jsdoc -X ./path/to/js/files> name.json也会创建注释代码的JSON表示形式,但又很隐秘,不太实用。
我正在寻找这样的东西:
/**
* This is a function.
*
* @param {string} bar A parameter
* @returns {string} A string
*/
function foo(bar) {
// do something...
return bar;
}
/**
* This is another function.
*
* @param {string} foo A parameter
*/
function bar(foo) {
// do something...
}
应创建如下内容:
{
"documentation": [
{
"function-name": "foo(bar)"
"description": "This is a function.",
"params": [
{
"param": "bar",
"description": "A parameter",
"type": "string"
}
],
"returns": {
"description": "A string",
"type": "string"
}
},
{
"function-name": "bar(foo)"
"description": "This is another function.",
"params": [
{
"param": "foo",
"description": "A parameter",
"type": "string"
}
]
}
]
}
像这样,我可以创建一个名为“ documentaion”的链接,其中列出了所有功能及其文档 在我的温泉浴场内 。