Objective C 这种自解释型的语言需要很长的文档么?

2013-02-07 15:43:52 +08:00
 alexrezit
我的项目通常只有特别复杂的地方才加上一些注释, 而且我也认为这种语言本身的特性就不需要很复杂的文档, 被吐槽了... = =

- 我们之前的项目文档比程序都长.
- 私以为 Objective C 的东西只有闭源项目才需要文档.
- 凡是程序都要有文档啊亲. 优秀是一种习惯.
- ...
2428 次点击
所在节点    问与答
3 条回复
saharabear
2013-02-07 19:42:36 +08:00
这个。。。。。。。。。

我不多说了,座等评论。

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

不然,就没大有必要多写注释了。

这是一个专为移动设备优化的页面(即为了让你能够在 Google 搜索结果里秒开这个页面),如果你希望参与 V2EX 社区的讨论,你可以继续到 V2EX 上打开本讨论主题的完整版本。

https://www.v2ex.com/t/60035

V2EX 是创意工作者们的社区,是一个分享自己正在做的有趣事物、交流想法,可以遇见新朋友甚至新机会的地方。

V2EX is a community of developers, designers and creative people.

© 2021 V2EX