JsDoc呈现整个代码,而不是注释块



我有一个VUE.JS应用程序,我们需要对它进行文档化,对于VUE组件,我们决定使用Vuese,但问题出现在常规JS文件(如模块等(上,因此我们决定使用JsDoc我安装了它,一切都很好,但当我生成JsDoc的HTML文件时,它会呈现整个代码,而不是我的评论行

这是一个的例子

/** This is a description of the foo function. */
function myfunction() {
alert('hello world');
}
console.log(myfunction);

我得到这个

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Source: test.js</title>
<script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<div id="main">
<h1 class="page-title">Source: test.js</h1>


<section>
<article>
<pre class="prettyprint source linenums"><code>/** This is a description of the foo function */
function myfunction() {
alert('hello world');
}
console.log(myfunction);
</code></pre>
</article>
</section>



</div>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Global</h3><ul><li><a href="global.html#myfunction">myfunction</a></li></ul>
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Thu Jun 24 2021 14:28:24 GMT-0300 (hora estándar de Argentina)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>

可能是什么?或者我做错了什么?

注意:我安装了JsDoc global,并尝试使用我的jsdocrc.json和单独使用命令JsDoc-(PathOfMyJsFile(

TLTR:基本上它是呈现整个代码,而不是我的JsDoc注释

由于evolutionxbox表示格式错误,请仔细检查jsdoc文档

https://jsdoc.app/tags-description.html

相关内容

  • 没有找到相关文章

最新更新