JsDoc：如何记录一个对象可以具有任意（未知）属性，但具有特定类型的信息？
这与问题30360391类似。我想表达的是函数的参数是一个普通的JS对象，它可以具有任意属性（具有未知名称），但所有属性本身都是具有固定属性的对象。 例如：函数就像这样。 /** * @param {Descriptor} desc */ function foo( desc ) { ...
JSDoc 二维数组
我有一个字符串的数组数组，但我不知道如何使用JSDoc进行文档化。/** @class */ function PostbackList() { /** @type {int} @default */ this.TypeID = 0; /** ...
AMD + Backbone + JSDoc3 最佳文档化方式
我正在寻找最好的记录代码的方式，但是我找不到任何东西。 我看过其他主题，包括这个，但它们都没有解决我的问题。 我有类似这样的东西： define([ 'backbone' ], function (Backbone) { /** * @module model...
如何创建自己的jsdoc模板的详细文档是否存在？
简短版： 如果我想从头开始开发一个全新的 jsDoc 模板，我需要阅读哪些内容以理解 jsDoc 的功能、模板所必须提供的接口以及需要处理的数据？ 详细版： 我已经使用了一段时间的 jsDoc，并遇到了一些我想要添加的标签和我想要生成的概述页面。到目前为止，我通过usejsdoc.org解决...
如何使用jsdoc记录回调的正确方式？
我在网上搜索了很久，寻找用jsdoc正确记录回调函数的最佳方法，但不幸的是，我还没有找到一个很好的方法。 这是我的问题： 我正在为开发人员编写一个Node.js库。该库提供多个类、函数和方法供开发人员使用。 为了使我的代码清晰易懂，并且（希望）能够在未来自动生成一些API文档，我开始在我...
React Hooks - 使用解构数组变量的JSDoc
我正在尝试使用hooks为一个简单的React Typescript组件进行JSDoc注释。不幸的是，我似乎找不到一种让JSDoc与已声明的解构数组配合使用的方法。有关解构对象参数的一些答案，但这些不适用于数组。/** * @property {boolean} 0 - documentat...
TypeScript会剥离注释并破坏JSDoc文档。
目标是从TypeScript代码获取JSDoc文档。TypeDoc（TypeScript文档解决方案）的文档质量不可接受，因为该文档针对的是JS用户，不应淹没特定于TypeScript实现的细节（接口等）。当前，将TypeScript编译成ES6并从JS文件生成文档基本可以解决问题。但未分配值...
基本数据类型的名称需要大写还是小写？
/** * @param {String} foo * @param {Number} bar */ 或者/** * @param {string} foo * @param {number} bar */ JSDoc的@type文档并没有明确说明。 我总是将String和Numb...
JSDoc与AngularJS的结合
目前在我的项目中我们正在使用JSDoc，最近我们开始实施Angular，并且我希望继续使用JSDoc以确保所有文档都在同一位置。 我看过很多人主要只是建议使用ngDoc，但这并不是一个可行的选择，因为我们将始终有单独的JavaScript文件，我更希望所有文档都在一起。/** * @aut...
如何在Ubuntu上对整个目录运行jsdoc
我只需要在包含.js文件的整个目录上运行jsdoc。我在Ubuntu终端上通过发出命令jsdoc abc.js 在单个文件上执行此操作，但我需要一次将此命令应用于目录中的所有文件，以便该目录中包含js文件的所有文件都会生成单个命令。感谢您提供的任何帮助。