金辉---自动生成API文档.pptxVIP

自动生成API文档-接口文档工具增加开发效率启言：程序员的烦恼10. 注释 — 只解释了“how”却没有解释“why”9. 干扰8. 范围蠕变（Scope creep）7. 管理者 — 完全不懂编程6. 写文档5. 程序 — 缺少文档4. 硬件3. 含糊不清2. 其他程序员1. 自己写的代码 — 6个月以后的开发与沟通1. 程序开发写注释方便自己看也方便别人看，3个月已经就忘记了可以利用工具自动生成文档每个变量的类型更明确返回的格式的标准化2. 前端对接需要写文档告诉前端每个参数什么用接口地址前端的格式，是否跨平台3. 程序测试白盒测试需要分析代码解释每个参数的意义调试需要修改的参数注释规范和标准常规注释/** * @name 名字 * @abstract 申明变量/类/方法 * @access 指明这个变量、类、函数/方法的存取权限 * @author 函数作者的名字和邮箱地址 * @category 组织packages * @copyright 指明版权信息 * @const 指明常量 * @deprecate 指明不推荐或者是废弃的信息* @deprec 与deprecate含义相同 * @example 示例 * @exclude 指明当前的注释将不进行分析，不出现在文挡中 * @final 指明这是一个最终的类、方法、属性，禁止派生、修改。 *