惯性聚合 高效追踪和阅读你感兴趣的博客、新闻、科技资讯
阅读原文 在惯性聚合中打开

推荐订阅源

Google DeepMind News
Google DeepMind News
Stack Overflow Blog
Stack Overflow Blog
Hugging Face - Blog
Hugging Face - Blog
博客园_首页
T
The Blog of Author Tim Ferriss
博客园 - 叶小钗
N
Netflix TechBlog - Medium
腾讯CDC
C
Check Point Blog
P
Proofpoint News Feed
Engineering at Meta
Engineering at Meta
GbyAI
GbyAI
S
SegmentFault 最新的问题
F
Fortinet All Blogs
美团技术团队
U
Unit 42
freeCodeCamp Programming Tutorials: Python, JavaScript, Git & More
博客园 - 司徒正美
F
Full Disclosure
Recorded Future
Recorded Future
D
DataBreaches.Net
博客园 - 【当耐特】
Martin Fowler
Martin Fowler
J
Java Code Geeks
I
InfoQ
Y
Y Combinator Blog
A
About on SuperTechFans
AI
AI
爱范儿
爱范儿
Exploit-DB.com RSS Feed
Exploit-DB.com RSS Feed
Forbes - Security
Forbes - Security
W
WeLiveSecurity
M
MIT News - Artificial intelligence
雷峰网
雷峰网
cs.CV updates on arXiv.org
cs.CV updates on arXiv.org
Simon Willison's Weblog
Simon Willison's Weblog
Schneier on Security
Schneier on Security
The GitHub Blog
The GitHub Blog
Security Archives - TechRepublic
Security Archives - TechRepublic
aimingoo的专栏
aimingoo的专栏
Cyber Security Advisories - MS-ISAC
Cyber Security Advisories - MS-ISAC
G
GRAHAM CLULEY
Know Your Adversary
Know Your Adversary
Latest news
Latest news
Threat Intelligence Blog | Flashpoint
Threat Intelligence Blog | Flashpoint
D
Docker
Recent Commits to openclaw:main
Recent Commits to openclaw:main
量子位
V2EX - 技术
V2EX - 技术
Project Zero
Project Zero

博客园 - SeanLin

Cocos2d-html5资源预加载列表自动扫描脚本 JSDoc参考注释模板 [转]Git常用操作命令 Cocos2d-html5 HelloWorld模板和引擎使用简介 HTML5游戏开发涉及到的安全问题 Javascript开发的HTML5游戏的知识产权保护 CCTextureCache的多线程加载原理和使用 引擎demo任务 引擎初始化过程 引擎开发数据记录 游戏引擎消息循环机制 渲染部分 几个需要思考的问题 【转】使用Jasob混淆javascript代码 【转】html5游戏开发引擎大全 【转】V8 Javascript 引擎设计理念 android 字体位置信息 【转】蓝牙协议中HCI层的研究与开发 【转】蓝牙协议的命令和事件
Javascript API Document生成工具JSDoc
SeanLin · 2012-05-15 · via 博客园 - SeanLin

    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:版本