Js doc toolkit
Upcoming SlideShare
Loading in...5
×
 

Js doc toolkit

on

  • 1,642 views

 

Statistics

Views

Total Views
1,642
Views on SlideShare
1,642
Embed Views
0

Actions

Likes
4
Downloads
103
Comments
0

0 Embeds 0

No embeds

Accessibility

Categories

Upload Details

Uploaded via as Adobe PDF

Usage Rights

© All Rights Reserved

Report content

Flagged as inappropriate Flag as inappropriate
Flag as inappropriate

Select your reason for flagging this presentation as inappropriate.

Cancel
  • Full Name Full Name Comment goes here.
    Are you sure you want to
    Your message goes here
    Processing…
Post Comment
Edit your comment

Js doc toolkit Js doc toolkit Presentation Transcript

  • JsDoc Toolkit 2011‐06‐02 JsDoc ToolKit @author 郝黎
  • JsDoc Toolkit介绍JsDoc Toolkit标签 JsDoc ToolKit
  • JsDoc人物: Michael Mathews 开源 JsDoc Toolkit sourceforge Google code 人物:Gabriel Reid 2001 2002 2006开发语言:Perl 开发语言:Java运行要求: 运行要求:Java环境Perl环境 & HTML::Template的Perl模块 JsDoc ToolKit
  • 自动化文档生成工具,根据约定的JavaScript中的注释自动生成API文档 JsDoc ToolKit
  • 1、配置Java环境2、下载JsDoc toolkit压缩包3、敲命令1、不需要配置Java环境2、不需要下载JsDoc toolkit压缩包3、 点击鼠标 JsDoc ToolKit
  • JsDoc Toolkit介绍JsDoc Toolkit标签 JsDoc ToolKit
  • @author 作者 @name 强制jsdoc toolkit忽略周围的代 码,显示声明jsdoc不能自动检@class 声明对象 测的对象 @namespace 声明命名空间@constant 声明常量 @param 描述参数@constructor 标识构造函数 @private 声明私有对象@default 变量的默认值 @property 显示声明一个属性@description 给出描述 @public 声明共有对象@example 例子代码 @requires 声明所依赖的对象或文件 @returns 返回值@field 表明该变量是指非函数 @see 声明可参考的其他对象@fileOverview 文件总体描述 @static 显示声明一个静态对象 表明函数 @throws 声明函数执行过程中可能抛出@function 的异常@inner 表明是个内部函数,所以也是 @type 声明变量类型或者函数返回值 个私有函数 类型@memberOf 某一个对象的成员 @version 版本号 JsDoc ToolKit
  • /** * @tag1 * @tag2 */1. 严格按照JsDoc规定的格式书写2. 否则JsDoc不会理睬注释,自己 解析代码的上下文生成文档 JsDoc ToolKit
  • 对JavaScript文档的总体描述对Person对象的描述 JsDoc ToolKit
  • 第一部分,总体描述 /** @fileOverview  对js文件的总体描述 @author  作者 @version  版本号 */ JsDoc ToolKit
  • 第二部分,对象的描述 /** @class 对象的描述 @constructor (构造器) @param  {参数类型}  参数名 参数的描述 @returns  {返回类型} 返回值的描述 */ JsDoc ToolKit
  • 简单的@就能生成文档 @type  声明变量类型或者函数返回值 类型 @returns  返回值 JsDoc ToolKit
  • 甚至基本不用@也能生成文档 JsDoc ToolKit
  • 那还有必要写@吗? JsDoc ToolKit
  • 没有代码,只要@,也能生成文档! JsDoc ToolKit
  • 归功于@name与@memberOf的运用 配合@field和@function@name 声明对象 (强制jsdoc忽略周围的代码,显示声明jsdoc不能自动检测的对象)@memberOf    声明对象的成员@field (强制jsdoc声明一个非函数)  @function    (表明函数) JsDoc ToolKit
  • @memberOf JsDoc ToolKit
  • @name声明原型函数 @name  name  @name Person#name    等价于 @memberOf  Person# JsDoc ToolKit
  • @name声明匿名‐内部函数 JsDoc ToolKit
  • @name小心~!!!<inner>  p1()    &&  <static> Person.p1()  ??!! JsDoc ToolKit
  • @field & @function@function  (声明函数)@field  (声明非函数) JsDoc ToolKit
  • @example & @link@link  {@link tag} 到文档中其他标签说明的html链接@example  举例 JsDoc ToolKit
  • 会用这些常用的标签已经足够了@ fileOverview , @author , @version,@class, @constructor, @param, @return, @type, @function, @field, @name, @memberOf, @constant, @static @example, @link, @see其实还有许多标签……@borrows ,@lends, @event, @ignore, @exports, @private, @public, @property, @since ,@throws… JsDoc ToolKit
  • JsDoc文档管理平台登录 http://bj.ued.taobao.net/jsdocplat/
  • JsDoc文档管理平台添加项目 http://bj.ued.taobao.net/jsdocplat/
  • JsDoc文档管理平台项目列表 http://bj.ued.taobao.net/jsdocplat/
  • JsDoc文档管理平台我的项目 http://bj.ued.taobao.net/jsdocplat/
  • JsDoc文档管理平台 http://bj.ued.taobao.net/jsdocplat/
  • Thank you! JsDoc ToolKit