文档注释、文档生成工具、JavaDoc、JSDoc

创建时间:
2014-03-08 23:15
最近更新:
2018-10-19 19:51

Resource - MSDN

  1. XML 文档注释 (C#, Visual Studio) (C# 编程指南) - Entrance
  2. /doc (C# 编译器选项)
  3. 建议的文档注释标记 (C# 编程指南)

Resource

  1. 微软开源全新的文档生成工具 DocFX
  2. SandCastle
  3. SandCastle
  4. SandCastle
  5. SandCastle
  6. GhostDoc
  7. .NET 注释之旅
  8. 把 Visual Studio .NET 源代码文件中 C# XML 注释提取成工程文档
  9. .NET 中的自动文档生成工具

.NET 文档生成工具 ADB

  1. 貌似 SandCastle 只能为单个程序集生成文档,而 ADB 可以合并多个程序集
  2. .NET 平台开源项目速览 (4) .NET 文档生成工具 ADB 及使用
  3. .NET 文档生成工具 2.2 扩展注释标志
  4. .NET 文档生成工具 ADB 使用图文教程

JavaScript 文档注释

在函数上一行输入 /** 并回车会自动生成 doc 注释,Aptana/WebStorm 适用。

JSDoc Toolkit
自动化文档工具,它是发布在 Google Code 上的一个开源项目,和其他语言的文档工具一样,它可以自动从 JavaScript 代码中提取注释生成格式化文档。
http://code.google.com/p/jsdoc-toolkit/downloads/list
http://cnmqw.iteye.com/blog/894707

JS 文档生成工具:JSDoc 介绍
http://www.jianshu.com/p/6c49e2a0cebe

XML 文档注释 (JavaScript)
https://msdn.microsoft.com/zh-cn/expression/hh524453

JavaScript 注释
http://www.cnblogs.com/rentj1/archive/2012/11/12/2766541.html

利用 JSDoc 提高自动提示 — WebStorm 入门指南
http://www.tuicool.com/articles/AZRvAr

JSDoc Official Website

@use JSDoc
An API documentation generator for JavaScript.
http://usejsdoc.org/
http://github.com/jsdoc3/jsdoc

@param
http://usejsdoc.org/tags-param.html

ZRender API Documentation 的页脚为: "Documentation generated by JSDoc 3.3.0-beta1 on Thu May 28 2015 14:42:42 GMT+0800 (CST)"。