V2EX = way to explore
V2EX 是一个关于分享和探索的地方
现在注册
已注册用户请  登录
V2EX 提问指南
alexrezit
V2EX  ›  问与答

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

  •  
  •   alexrezit · 2013-02-07 15:43:52 +08:00 · 2479 次点击
    这是一个创建于 4307 天前的主题,其中的信息可能已经有所发展或是发生改变。
    我的项目通常只有特别复杂的地方才加上一些注释, 而且我也认为这种语言本身的特性就不需要很复杂的文档, 被吐槽了... = =

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

    我不多说了,座等评论。

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

    不然,就没大有必要多写注释了。
    关于   ·   帮助文档   ·   博客   ·   API   ·   FAQ   ·   实用小工具   ·   2656 人在线   最高记录 6679   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 30ms · UTC 02:48 · PVG 10:48 · LAX 18:48 · JFK 21:48
    Developed with CodeLauncher
    ♥ Do have faith in what you're doing.