JsDoc
如果你在写javascript,是否羡慕过C++,JAVA的文档自动生成工具?是否希望自己的程序也能自动生成一份对应的文档,犹如java API文档一样呢?不要再羡慕了。jsdoc_toolkit.zip 一款强大的js doc生成工具已经能完成你所羡慕这些功能了。
你可以访问该工具的主页:http://www.jsdoctoolkit.org/ 查看相关用法。这是一个JAVA开发的开源项目,下面只是记录一些使用过程中常见的细节:
将下载的 jsdoc_toolkit.zip解压后,其中的README.txt 有使用说明。 我可不想每次用的时候都去命令下做这些操作,于是我在解压后的目录里新建了一个run.bat 内容编辑如下:
java -jar jsrun.jar app/run.js -a -t=templates/jsdoc js/*.js
根据上面的命令,建立一个目录,名字为 js 。显然我们将需要提取文档的js文件命名为*.js ,并且放在js目录下,执行run.bat就OK。
什么这么简单? 对就是这么简单,不过,你的js文件符合jsdoc规范吗?
如果你发现自己操作起来不是那么顺利,那么:
http://www.jsdoctoolkit.org/wiki/?page=Tag%20Reference 主页上的这篇文章对你有所帮助,意思就是你的注释应该符合他的标准。
有人说我英语太差,好吧。我就把常见的一些注释规范或者是他jsdoc工具能识别的标识写出来:
@author:作者
@argument:参数
@augments:参数
@class: 类
@constant:常数
@constructor:构造
@constructs: 构造
@default:默认值
@deprecated: 推荐,说明使用一个变量已不再支持
@description:说明
@example :范例
@extends: 扩展 ,继承
@field:变量(非功能)
@fileOverview :整个文件信息
@function: 功能 (表示该变量指向一个功能)
@inner || @private : 私有,内部
@ignore: 忽视 (文档生成的式后也将忽视这个变量)
@event:事件
@version:版本
@type:类型 描述预期的类型变量的值或返回值的函数
@throws :可能抛出的异常
@static: 静态,访问该变量不需要实例
@since: 自 (表明某属性特征,是在什么版本之后才有的)
@see: 描述相关的资源
@scope ||@lends: 作用域
@return ||@returns
@requires: 描述必须需要的资源
@public: 说明内在变量是公开的
@property : 属性
@param:参数
@namespace: 命名空间
较多用法如下:
eg:
/**
* @fileOverview 功能接口调用
* @author -274°C
* @constructor BlogJava.Data
* @description [数据结构]命名空间
* @see The <a href="http://www.example.com">Example Project</a>.
* @param {NULL_PARAMETER} objNull
* @param {Function} [fnCallback="null"] :如果不是函数类型,则进行同步调用
* @return {Boolean} json :作为回调参数返回
* @example new KxEFileMon.Data.NULL_PARAMETER("a")
*/
转自:http://www.blogjava.net/JAVA-HE/archive/2008/11/25/242477.html?opt=admin
分享到:
相关推荐
JsDoc Toolkit不久前发布了2.3.2版本,主要还是对前版本的修复。 如果你需要使用Ant,JsDoc还有一个Ant插件:JsDoc Toolkit Ant Task 下载JsDoc Toolkit2.3.2:...
入门swagger-jsdoc将经过验证的OpenAPI规范返回为JSON或YAML。 const swaggerJsdoc = require ( 'swagger-jsdoc' ) ;const options = { swaggerDefinition : { openapi : '3.0.0' , info : { title : 'Hello World' ...
JSdoc-Toolkit是一款强大的JavaScript文档生成工具,它基于JSDoc规范,用于从注释中提取代码信息,并生成清晰、结构化的API文档。通过在代码中添加特定格式的注释,开发者可以方便地为项目创建专业级别的文档,提高...
**ljve-jsdoc-template** 的核心价值在于,它为JSDoc 3提供了一套特定的样式和布局,这使得生成的文档不仅具备标准JSDoc的规范性,还融合了ljve.io的视觉风格,提升了用户体验。这通常包括但不限于自定义的CSS样式、...
JsDoc Toolkit 是一个把js描述格式化成文档的工具。开发者只需按JsDoc的规范写好注释就可以很方便导出文档。这个JsDoc是Java版本的,用起来方便一些。这也是 google 推荐的 JsDoc 输出工具
1. **自动化文档生成**:UI5-JSDoc-Generator 能够自动扫描UI5编辑器中的控件库,提取相关的JSDoc注释,并自动生成对应的文档,减少手动编写文档的工作量。 2. **支持多种注释格式**:工具兼容多种JSDoc注释风格,...
**JSDoc AMD 注释生成与 JaguarJS 模板详解** 在 JavaScript 开发中,文档的编写是不可或缺的一部分,它能够帮助开发者理解代码的功能和用法,提高代码的可读性和可维护性。JSDoc 是一个用于生成 API 文档的工具,...
这种注释格式是基于JSDoc3,一种广泛使用的JavaScript文档注释规范。通过使用JSdoc,开发者可以轻松地为他们的代码提供清晰、结构化的文档,这对于团队协作和维护大型代码库尤其重要。 "atom-3en-jsdoc"插件则将...
JsDoc Toolkit 是一个把js描述格式化成文档的工具。开发者只需按JsDoc的规范写好注释就可以很方便导出文档。这个JsDoc是Java版本的,用起来方便一些。这也是 google 推荐的 JsDoc 输出工具
JsDoc Toolkit 基于一套预定义的注释模板,这些模板基于JSDoc3的规范,例如`@param`, `@return`, `@function`, `@class`等。通过在函数、类、变量等定义前添加这些注释,可以明确地记录它们的用途、参数、返回值等...
swagger-jsdoc, 在JSDoc上生成 swagger doc swagger记录代码并保持实时和可以重用的OpenAPI ( Swagger ) 规范。 这里规范可以是你的api驱动项目的核心: generate,服务器,客户,测试,以及更多的基于丰富的OpenAPI...
JsDoc Toolkit 是一个把js描述格式化成文档的工具。开发者只需按JsDoc的规范写好注释就可以很方便导出文档。这个JsDoc是Java版本的,用起来方便一些。这也是 google 推荐的 JsDoc 输出工具
JSDoc是一种用于JavaScript代码注释的规范,它允许程序员通过特殊的注释语法来记录函数、类、变量等的文档信息。这些注释可以自动生成API文档,帮助其他开发者理解和使用代码。在JavaScript开发中,良好的JSDoc注释...
openapi-jsdoc以json格式返回OpenAPI规范。 const openapiJSDoc = require ( 'openapi-jsdoc' ) const api = openapiJSDoc ( { definition : { // info object, see ...
JSDoc是一种用于JavaScript代码的注释规范,它允许开发者通过特殊的注释语法来描述函数、类、变量等对象的结构、功能和使用方式。JSDoc注释通常包含`@param`、`@return`、`@class`、`@function`等标签,这些标签提供...
总的来说,`jsdoc-toolkit`作为早期的JS Doc实现,虽然现在可能已被其他工具取代,但它仍然是理解JSDoc概念和实践代码注释规范的好起点。通过良好的文档,我们可以提高代码的可维护性和团队效率,无论是在小型项目...
3. **注释代码**: 在源代码中添加JSDoc注释,遵循JSDoc的注释规范。 4. **生成文档**: 运行JSDoc命令,如`jsdoc -c jsdoc.conf.json`,它会根据配置文件解析源代码并生成文档。 5. **查看文档**: 生成的HTML文档...
JsDoc Toolkit 是一款功能强大的文档生成工具,它能够帮助开发者根据预定义的注释格式(即JsDoc规范)自动生成高质量的API文档。这对于提高代码可读性、维护性和团队协作效率具有重要意义。本文将详细介绍JsDoc ...
Java JsDoc Toolkit v2.0文档工具下载,可以把javaScript描述信息格式化,开发者只要按JsDoc规范写好注释就可以很方便的导出文档。这是Java版本的,附有JAVA源文件,这款工具也是google 极力推荐的JsDoc输出工具。