浅谈javadoc这种写说明书的方式

实在感觉这个 javadoc 太不友好了,这个感觉是给写这个程序的开发者看的一种备忘录,而不是给调用这个方法的人看的说明书。

具体来说,它至少有如下的劣势:

  1. 使用者往往是有需求了才会来读说明书的,他需要的可能是这种格式:场景,需求,怎么用。最好有一点带code的说明,然后具体地说这个参数是什么意思。
    但是现在这种javadoc写的一串,读起来佶屈聱牙的文字,让人完全看不懂。

  2. javadoc 写的都是一个个的类,接口什么的那些东西。而调用者往往想知道的是,你怎么样建立起这些 抽象体与实体的。还有最终的就是怎么用,怎么把这些东西组合起来使用。javadoc有些类根本没有这东西。

你可能感兴趣的:(浅谈javadoc这种写说明书的方式)