【集思广益】公司的项目该不该写API~ - java吧 - RAT

【集思广益】公司的项目该不该写API~

level 9

ghtjkl 楼主

一个项目少说几百个类。。。多则上千
类里的方法也很多。。。
这样对于一个新人来说很难快速加入到项目里
因为对一些类或方法不熟悉或根本不知道其存在，
比如我最近写的这个功能模块。。。每次卡住的时候
找到大神帮我。。总会看到陌生的类和方法。。
而且没有API想找个类或方法无从下手。。。。
找类找到大概的包。。然后去找。。找方法。。就得用.这个方法挨个看
很是麻烦啊。。
一个项目应不应该稍微花点时间去写个API方便coder去完成项目呢

2012年11月21日 02点11分 1

level 10

cnfree2000

你那是javadoc，不是api

2012年11月21日 02点11分 3

level 16

windsun_ul

doc 注释自然要写

2012年11月21日 02点11分 4

ghtjkl

好多类。。。有时候为了找他们之间的关系花费半天，方法也是不知道以前都写好了没，是不是需要自己写 [拍砖]

[拍砖]

2012年11月21日 02点11分

level 10

cnfree2000

我是从来不写公司的项目 doc，专门有人维护那个，个人opensource项目不得不写，还得花大功夫写英文doc，55555，好想找人专门写这个

2012年11月21日 02点11分 5

ghtjkl

。。。。呃

2012年11月21日 02点11分

level 10

tia_nxia

没必要、、javadoc就可以。

2012年11月21日 02点11分 6

level 13

ayane000

(为什么)
有时候写了文档也特么得看代码才能懂

2012年11月21日 02点11分 7

ghtjkl

唉~ 没招啊咱这行参差不齐的。。有时候没注释你看代码都不知道那代码是干嘛的。。。

2012年11月21日 02点11分

ayane000

回复 ghtjkl :所以看别人代码不如自己重新写一遍

2012年11月21日 02点11分

level 11

稍大点的项目一般都会有文档吧

2012年11月21日 02点11分 8

1