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

Question

我有一个 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 评论

Answer 1

正如evolutionxbox所说的格式错误，仔细检查jsdoc文档

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

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

JsDoc renders whole code instead of commented block

javascript

documentation

render

jsdoc

vue.js