l**********n
发帖数: 8443 | 1 I used jsdoc, closure. I need opinion on which one is the best. |
l**********n
发帖数: 8443 | 2 it is better it has searching capabilities.
【在 l**********n 的大作中提到】
: I used jsdoc, closure. I need opinion on which one is the best.
|
d****n
发帖数: 1637 | 3 从来不doc,汗一个。 遇到感觉自己难懂的地方写两句，大多都靠framework的
convention
等大牛来揭晓答案 |
e*******o
发帖数: 4654 | 4 jsduck
【在 l**********n 的大作中提到】
: I used jsdoc, closure. I need opinion on which one is the best.
|
d****n
发帖数: 1637 | 5 谢谢分享。
另外说一句，以前也用国docgen之类了，可是后来看见冷冰冰的doc就不怎么热情了。
不如直接看developer notes之类.加上src code.尤其是github上，还不伤眼睛
【在 e*******o 的大作中提到】
: jsduck
|
l**********n
发帖数: 8443 | 6 因为js没有package，我不知道doc generator怎么组织doc。不是所有的code都遵照CJS
或者AMD，有的就是exposed to global.
【在 d****n 的大作中提到】
: 谢谢分享。
: 另外说一句，以前也用国docgen之类了，可是后来看见冷冰冰的doc就不怎么热情了。
: 不如直接看developer notes之类.加上src code.尤其是github上，还不伤眼睛
|
e*******o
发帖数: 4654 | 7 jsduck是sencha搞的 sencha js 自带class system
我们的Perl doc 也是用的jsduck
sencha时候比较大的项目
我比较讨厌sencha的东西 不过这个还可以用
CJS
【在 l**********n 的大作中提到】
: 因为js没有package，我不知道doc generator怎么组织doc。不是所有的code都遵照CJS
: 或者AMD，有的就是exposed to global.
|
l**********n
发帖数: 8443 | 8 jsdoc有@namespace这个tag
【在 e*******o 的大作中提到】
: jsduck是sencha搞的 sencha js 自带class system
: 我们的Perl doc 也是用的jsduck
: sencha时候比较大的项目
: 我比较讨厌sencha的东西 不过这个还可以用
:
: CJS
|
d****n
发帖数: 1637 | 9 这个doc tag convention很不喜欢。
你就是知道要怎么doc，但是还是懒着遵循。
一开始pycharm给的intelisense 挺希奇，后来都不用了。
自由发挥，comments还是最习惯的doc。
看来我没啥早就了，哎 |
e*******o
发帖数: 4654 | 10 review
commit 之后 doc 编译有错误的话，会给所有人发邮件。
有时候还是比较有用的。理想的状态是把 code 自己当doc。
【在 d****n 的大作中提到】
: 这个doc tag convention很不喜欢。
: 你就是知道要怎么doc，但是还是懒着遵循。
: 一开始pycharm给的intelisense 挺希奇，后来都不用了。
: 自由发挥，comments还是最习惯的doc。
: 看来我没啥早就了，哎
|
L***s
发帖数: 1148 | 11 我爱写doc/comments，但常常在code review时被队友勒令删除，
理由是“clean up”、“keep consistent with existing code (which
doesn't have any comments”
【在 d****n 的大作中提到】
: 从来不doc,汗一个。 遇到感觉自己难懂的地方写两句，大多都靠framework的
: convention
: 等大牛来揭晓答案
|
z****e
发帖数: 54598 | 12 有这种傻逼队友真是够呛
有人写comments真是求之不得，在接盘的时候
【在 L***s 的大作中提到】
: 我爱写doc/comments，但常常在code review时被队友勒令删除，
: 理由是“clean up”、“keep consistent with existing code (which
: doesn't have any comments”
|
