实在感觉这个 javadoc 太不友好了，这个感觉是给写这个程序的开发者看的一种备忘录，而不是给调用这个方法的人看的说明书。
具体来说，它至少有如下的劣势：
使用者往往是有需求了才会来读说明书的，他需要的可能是这种格式：场景，需求，怎么用。最好有一点带code的说明，然后具体地说这个参数是什么意思。
但是现在这种javadoc写的一串，读起来佶屈聱牙的文字，让人完全看不懂。
javadoc 写的都是一个个的类，接口什么的那些东西。而调用者往往想知道的是，你怎么样建立起这些 抽象体与实体的。还有最终的就是怎么用，怎么把这些东西组合起来使用。javadoc有些类根本没有这东西。
实在感觉这个 javadoc 太不友好了，这个感觉是给写这个程序的开发者看的一种备忘录，而不是给调用这个方法的人看...
Javadoc标记 介绍常用的javadoc，全部javadoc可以见官网的 javadoc。 @author 用...
1.接口逻辑测试 如果要保证接口测试的顺利进行，开发人员 JavaDoc 的输写定不可少，如何测试 JavaDoc...
JavaDoc注释和eclipse如何导出文档 JavaDoc注释 Javadoc注释的用法 eclipse如何导...
1.写工具类的文档注释 2.javadoc生成 javadoc -d 文件夹名（要保存生成一系列文件的文件夹名称）...
下载Javadoc: 简单使用： 生成Javadoc文档:
Javadoc简介 Javadoc是一项文档生成技术，用于从Java代码生成HTML文档。结构：Javadoc包含...
【强制】类、类属性、类方法的注释必须使用 Javadoc 规范，使用/*内容/格式，不得使用// xxx 方式。说...
浅谈思维导图 ——读/用《思维导图》有感 是否想过你自己大脑的说明书呢？又或者是否想过应该如...
类，类属性，类方法的注视必须使用javadoc规范，使用/** 内容 **/格式，不得使用// xxx方式（在ID...
本文标题：浅谈javadoc这种写说明书的方式
本文链接：https://www.haomeiwen.com/subject/xrxhrrtx.html
网友评论