1
saharabear 2013-02-07 19:42:36 +08:00
这个。。。。。。。。。
我不多说了,座等评论。 -------------- 好像我这样的回复不符合规定,那说几句:有什么样的语言不是自解释型的呢?文档是指API文档还是编码说明文档?应用是自己写着一套的还是写API给别的组用的? 这些对文档的要求不大一样吧? |
2
alexrezit OP @saharabear
编码说明文档是什么? 自己写着一套的... 我觉得像 Objective C 这种 caller 加上 method 连起来直接就是一句大白话的真心没啥必要, 想弄明白一个模块什么功能看文档不如看代码快. |
3
saharabear 2013-02-07 23:35:13 +08:00
@alexrezit 我觉得吧,如果是多人协作,别人可以轻松看明白输入和输出的,就没必要写注释了。但是如果真的有必要写注释,就定义一下除了输入和输出以外的东西,比如异常或者一些特殊的地方。
不然,就没大有必要多写注释了。 |