`
mutongwu
  • 浏览: 449913 次
  • 性别: Icon_minigender_1
  • 来自: 广州
社区版块
存档分类
最新评论

jsdoc使用

阅读更多
//使用说明:
java -jar jsrun.jar app/run.js --help

USAGE: java -jar jsrun.jar app/run.js [OPTIONS] <SRC_DIR> <SRC_FILE> ...

OPTIONS:
  -a or --allfunctions
          Include all functions, even undocumented ones.

  -c or --conf
          Load a configuration file.

  -d=<PATH> or --directory=<PATH>
          Output to this directory (defaults to "out").

  -D="myVar:My value" or --define="myVar:My value"
          Multiple. Define a variable, available in JsDoc as JSDOC.opt.D.m

  -e=<ENCODING> or --encoding=<ENCODING>
          Use this encoding to read and write files.

  -E="REGEX" or --exclude="REGEX"
          Multiple. Exclude files based on the supplied regex.

  -h or --help
          Show this message and exit.

  -n or --nocode
          Ignore all code, only document comments with @name tags.

  -o=<PATH> or --out=<PATH>
          Print log messages to a file (defaults to stdout).

  -p or --private
          Include symbols tagged as private, underscored and inner symbols

  -q or --quiet
          Do not output any messages, not even warnings.

  -r=<DEPTH> or --recurse=<DEPTH>
          Descend into src directories.

  -s or --suppress
          Suppress source code output.

  -S or --securemodules
          Use Secure Modules mode to parse source code.

  -t=<PATH> or --template=<PATH>
          Required. Use this template to format the output.

  -T or --test
          Run all unit tests and exit.

  -u or --unique
          Force file names to be unique, but not based on symbol names.

  -v or --verbose
          Provide verbose feedback about what is happening.

  -x=<EXT>[,EXT]... or --ext=<EXT>[,EXT]...
          Scan source files with the given extension/s (defaults to js).
	  
   This is an example of one way you could set up a configuration file to more
	conveniently define some commandline options. You might like to do this if
	you frequently reuse the same options. Note that you don't need to define
	every option in this file, you can combine a configuration file with
	additional options on the commandline if your wish.
	
	You would include this configuration file by running JsDoc Toolkit like so:
	java -jar jsrun.jar app/run.js -c=conf/sample.conf

下面列出了可以创建HTML文档的一些特殊 JSDoc标记。如果你曾在Java代码中编写过javadoc注释,应该对这些标记并不陌生。如果要在最后生成的文档中包含某个注释块,所有这些注释块都必须以/**开头,并以*/结束。

JSDoc 命令属性

命令名                描述
@param
@argument           指定参数名和说明来描述一个函数参数。
@return
@returns              描述函数的返回值。
@author               指示代码的作者。
@deprecated     指示一个函数已经废弃,不建议使用,而且在将来版本的代码中可能会彻底删除。要避免使用这段代码。
@see                    创建一个HTML链接指向指定类的描述。
@version              指定发布版本。
@requires             创建一个HTML链接,指向这个类所需的指定类。
@throws
@exception           描述函数可能抛出的异常的类型。
{@link}                创建一个HTML链接,指向指定的类。这与@see很类似,但{@link}能嵌在注释文本中。
@author                指示代码的作者。(译者注:这个标记前面已经出现过,建议去掉)
@fileoverview     这是一个特殊的标记,如果在文件的第一个文档块中使用这个标记,则指定该文档块的余下部分将用来提供文件的一个概述。
@class                  提供类的有关信息,用在构造函数的文档中。
@constructor        明确一个函数是某个类的构造函数。
@type                  指定函数的返回类型。
@extends             指示一个类派生了另一个类。通常JSDoc自己就可以检测出这种信息,不过,在某些情况下则必须使用这个标记。
@private              指示一个类或函数是私有的。私有类和函数不会出现在HTML文档中,除非运行JSDoc时提供了—private命令行选项。
@final                  指示一个值是常量值。要记住JavaScript无法真正保证一个值是常量。
@ignore JSDoc    会忽略有这个标记的函数。

//一个示例配置文件,对example/aTest.js文件建立文档,结果输出在output文件夹里面。

{
	// source files to use.文件夹或文件数组,不支持正则表达式
	_: ["example/aTest.js"],
	
	// document all functions, even uncommented ones
	a: false,
	
	// including those marked @private
	p: false,
	
	// some extra variables I want to include
	D: {generatedBy: "shawn", copyright: "2010"},
	
	// use this directory as the output directory
	d: "output",
	
	// use this template
	t: "templates/jsdoc"
}

/**什么都没有定义,将作为全局变量
 * globle namespace
 <b>同样支持HTML标签</b>
 [list][*]111
[*]222
[*]333
[/list]

 */
var shawn2 = {};

/**
*   用 @class,表示这是一个类。
	下面的两个方法将被视为 static方法
	@class 工具
*/
shawn2.util = {
	/**
	* 去除空格
	@param {String} str	 
	*/
	trim:function(str){},
	/**
	* 格式化
	@param {String} fmt	 
	*/
	format:function(fmt){}
};


/**
 * 必须用 @constructor 声明这是一个构造函数。
 * @class
 * @constructor
 * @param {Object} cfg
 */
shawn2.Calendar = function(cfg){
    this.cfg = cfg;
    this.name = cfg.name;
    this.id = cfg.id;
}
/**
* something
*/
shawn2.Calendar.prototype={
    /**
     * default type
     * @static
     * @type Number
     */
    defaultType: 1,
    /**
     * CSS 
     * @static 
     * @type String
     */
    cssStyle:'plain',
    /**
     * init
     */
    init:function(){},
	/**
	 * getValue
	 * @public
	 * @param {Number} type type
	   @static
     * @return 
			type =1,return A;type=2,return B
	 */
    getValue:function(type){
    }
}

截图:






  • 大小: 10.5 KB
  • 大小: 35.1 KB
  • 大小: 25.3 KB
分享到:
评论

相关推荐

    使用JSDoc建立JavaScript代码的文档

    ### 使用JSDoc建立JavaScript代码的文档 #### JSDoc简介 JSDoc是一种用于为JavaScript代码添加注释和文档的工具,它可以帮助开发者更好地理解代码功能与结构,并且能够自动生成HTML格式的API文档。这不仅提高了代码...

    JSDoc-1.10.2

    1. **注释解析**:JSDoc 使用一套特定的注释语法,如 `@param`、`@return` 和 `@class`,来标记函数参数、返回值和类定义等信息。这些注释可以在源代码中直接写入,便于文档的生成。 2. **模板支持**:JSDoc 支持...

    tidy-jsdoc:干净的JSDoc3模板

    要在项目中使用此jsdoc模板,请首先安装软件包: npm install --save-dev jsdoc tidy-jsdoc 产生文件 配置jsdoc并将语法添加到JavaScript文件后,您可以像这样生成HTML文件,并可以选择包含自述文件: jsdoc --...

    jsdoc-template:自定义 JSDoc 模板

    用法 jsdoc -t /path/to/jsdoc-template如果您使用 grunt-jsdoc,请确保在您的项目目录中安装最新的 jsdoc。 它附带的旧版本可能无法 100% 使用此模板,但在 node_modules 目录中选择一个并使用它就足够了。 'sample...

    JSDoc介绍1

    1. **API 文档生成器**:JSDoc 使用在代码中嵌入的特殊注释,解析这些注释后生成易于阅读的文档,展示类、方法、参数等信息。 2. **与 JavaDoc 和 PHPDoc 类似**:JSDoc 的注释格式和功能类似于 Java 的 JavaDoc 和...

    swagger-jsdoc:基于jsDoc注释和YAML文件生成swaggeropenapi规范

    swagger-jsdoc 该库读取带源代码,并生成。入门swagger-jsdoc将经过验证的OpenAPI规范返回为JSON或YAML。 const swaggerJsdoc = require ( 'swagger-jsdoc' ) ;const options = { swaggerDefinition : { openapi : '...

    js doc工具推荐及使用(一):jsdoc-toolkit

    本文将详细介绍`jsdoc-toolkit`,一个早期流行的JavaScript文档生成工具,并提供一些使用指导。 `jsdoc-toolkit`是一款基于JavaScript的文档生成工具,它解析JavaScript源代码中的JSDoc注释,然后根据这些注释生成...

    Atom-atom-3en-jsdoc,用于Atom的JSdoc插件,3en用于所有Suitescript项目.zip

    通过使用JSdoc,开发者可以轻松地为他们的代码提供清晰、结构化的文档,这对于团队协作和维护大型代码库尤其重要。 "atom-3en-jsdoc"插件则将JSdoc的功能集成到Atom编辑器中,使得在Atom内创建和维护Suitescript...

    HTML-Template-2.9.tar

    在解压后的HTML-Template-2.9目录中,可能还包含了一些示例或配置文件,展示了如何结合HTML模板和JSDoc使用。通过学习这些示例,你可以更好地理解如何自定义JSDoc的输出样式,使其与你的项目风格相匹配。 总之,...

    jsdoc AMD注释生成例子,用jaguarjs模板.

    本篇将深入探讨如何使用 JSDoc 与 AMD 结合,以及如何利用 JaguarJS 模板来生成更美观、更具结构化的文档。 ### 1. JSDoc 概述 JSDoc 是一种基于 JSDoc3 的注释语法,它允许开发者在 JavaScript 代码中添加注释,...

    前端开源库-ljve-jsdoc-template

    在使用 **ljve-jsdoc-template** 时,开发者需要按照JSDoc的注释规则在源代码中添加必要的注释,然后运行JSDoc工具,指定使用此模板来解析这些注释,生成HTML文档。这通常涉及以下步骤: 1. **安装**:首先,你需要...

    jsdoc-toolkit

    在给定的博客链接()中,作者可能详细介绍了如何使用JSdoc-Toolkit,包括安装、配置以及实际应用案例,帮助读者更好地理解和使用这个工具。 ### 应用场景 JSdoc-Toolkit广泛应用于开源项目和企业内部开发,尤其在...

    前端开源库-jsdoc-x

    5. **兼容性**: **jsdoc-x** 应该与大多数遵循JSDoc标准的代码兼容,这意味着它可以应用于广泛的各种JavaScript项目,无论它们使用的是ES5、ES6+,还是其他JavaScript方言。 **使用场景** 1. **自定义文档生成**: ...

    js doc 工具推荐及使用(一):jsdoc-toolkit

    本文主要介绍`jsdoc-toolkit`,一个早期流行的JS Doc实现,以及如何使用它来增强代码可读性和维护性。 首先,了解`jsdoc-toolkit`的基础概念。它是一个开源项目,提供了处理JavaScript源代码并生成文档的命令行工具...

    前端开源库-ui5-jsdoc-generator

    JSDoc 支持多种模板,可以生成不同风格的文档,方便开发者理解和使用代码库。 ### UI5与JSDoc结合 UI5 是由SAP公司开发的一个开放源代码的前端框架,主要用于构建企业级的Web应用程序。UI5 提供了丰富的组件和API...

    JSDoc 介绍使用规范JsDoc的使用介绍

    如果你需要使用Ant,JsDoc还有一个Ant插件:JsDoc Toolkit Ant Task 下载JsDoc Toolkit2.3.2:http://jsdoc-toolkit.googlecode.com/files/jsdoc_toolkit-2.3.2.zip命令名描述 @param @argument 指定参数名和说明来...

    前端开源库-jsdoc-webpack-plugin

    本文将深入探讨JSDoc、Webpack以及jsdoc-webpack-plugin的原理和使用方法。 首先,我们来了解**JSDoc**。JSDoc是一种用于JavaScript的文档生成工具,它允许开发者在代码中添加特定的注释格式,这些注释可以描述函数...

    JSDoc 参考手册.CHM

    JSDoc 参考手册.CHM、JSDoc 中文文档.CHM、JSDoc 中文教程.CHM

    flow-jsdoc, 使用JSDoc表示流量注释.zip

    flow-jsdoc, 使用JSDoc表示流量注释 流 jsdoc 这是一个将转换为标准的流类型注释的工具。 这意味着:你只需要记录你的类型一次: in 。无需使用 transpiler插件,就可以获得流的好处,而不必使用的ugly语法 。对于...

Global site tag (gtag.js) - Google Analytics