Javascript API Document生成工具JSDoc
Cocos2d-html5需要开始准备文档了,之前就知道Doxyzen是不可以的,只好找替代品。
JSDoc是目前的备选,目前代码包含的都是C++项目里面的注释,全部替换成JSDoc支持的tag标记,然后再用JSDoc工具去扫描目录。
生成的结果可真是一悲剧,没有定义的Class根本就无法扫描出来,没有定义其他tag的也基本都无法扫描出。
JSDoc不具备C++上Doxyzen的任何优势。
人家Doxyzen产生出来的文档,各种注释和继承结构都很齐全,丫丫的,各种羡慕嫉妒恨!!
好吧, 只好手动去注释各种tag了,Hurry Up,其中标注红色的,是文档结构产生的主要标记,
// JSDoc的各种tag:
@author:作者信息
@augments:参数
@class: 类
@constant:常数
@constructor:构造函数
@constructs: 可用于构造的特别函数
@default:默认值
@deprecated: 说明一个变量已不再支持
@description:描述
@example :范例
@extends: 扩展 ,继承
@event:事件
@field:声明非function类型
@fileOverview :文件信息
@function: 函数
@inner: 内部,等同于@private
@ignore: 忽略 (文档生成的之后也将忽略这个变量)
@namespace: 命名空间
@public: 说明内在变量是公开的
@private : 私有
@property :属性
@param:传入的参数
@static: 静态,访问该变量不需要实例
@since: 自什么版本之后才有
@see: 描述相关的资源
@lends: 描述对象的成员
@type:类型 描述预期的类型变量的值或返回值的函数
@throws :可能抛出的异常
@returns:返回参数
@requires: 需要的资源
@version:版本