V2EX = way to explore
V2EX 是一个关于分享和探索的地方
现在注册
已注册用户请  登录
爱意满满的作品展示区。
pheyer
V2EX  ›  分享创造

开源代码团队注释/翻译

  •  
  •   pheyer · 2016-05-09 10:27:39 +08:00 · 3682 次点击
    这是一个创建于 3104 天前的主题,其中的信息可能已经有所发展或是发生改变。

    这个世界上有很多开源代码,其中有不乏有很多著名的,多读读好的开源代码对自己应该还是益处多多的,然而多数开源代码文档不佳,注释也偏少,读起来还是挺痛苦的。

    一份开源代码如果有很多人读,我想是不是可以这样,弄一个开源代码团队分工注释的合作机制:一人读一个模块,理解后加上尽可能详尽的注释,然后合并,大家再读开源代码其他的模块省时省力,发现其他人的注释问题也可以修改,这应该也算是互帮互助吧。然后新手看这份开源代码也能省时省力,当然也可以加上打赏功能,毕竟前人是花了时间的。有了注释的话文档是不是也更写了呢?

    如果这可行的话,私以为各种开源代码管理平台最适合来组织这种活动,比如国外的 Github ,国内的 coding 和 osc 的,针对国内程序员的话 Github 可能不会指望了,但是国内的话如果有开源代码管理平台来组织这种事,会不会是一种差异化竞争力呢?

    上面说的是开源代码团队注释,下面来说说开源代码翻译。

    经常在 V2EX 上看到各种分享开源代码的,但是感觉很多都是重复的事情,比如我所知道的 V2EX 的 iOS 版本就已经有好多个了,还有那个 Gank 什么的,什么一不小心就做出来一个新的版本了,你在逗我😂

    可能大部分做这种事的是学生,也许是练手,也许是没有什么新点子没办法。但我就觉得你们还可以做一些其它的事情,比如我最近想到了一个是:代码翻译。所谓代码翻译,以 iOS/Android 为例,就是把 iOS 上有 Android 没有的完整开源项目翻译到 Android 上去,或者反过来把 Android 上面的完整开源项目翻译到 iOS 上去,其它语言也类似。

    如果上面的 iOS/Android 代码翻译做了一遍之后,会不会你比较弱的一种语言能力得到了加强呢?现在不是流行全栈吗,这种事情做了一遍之后是不是往全栈之路更推进了一步呢?

    只是异想天开,轻拍

    20 条回复    2016-05-11 08:54:39 +08:00
    Jung1e
        1
    Jung1e  
       2016-05-09 12:49:24 +08:00
    支持这种好人.
    sutra
        2
    sutra  
       2016-05-09 16:55:47 +08:00
    商业模式是什么?
    pheyer
        3
    pheyer  
    OP
       2016-05-09 16:56:59 +08:00
    @sutra 我就随便想想,没考虑那么远
    wjh3936
        4
    wjh3936  
       2016-05-09 17:05:03 +08:00
    其实重复造轮子大多数都只是在给自己练手而已吧……

    关于打赏部分挺赞同的,但是需要考虑到和代码管理平台合作,以及关于打赏分成——总得有作者的份吧?= =这样子的话又得考虑给作者打赏和给某次合并代码的人的打赏,想想挺乱的……
    pheyer
        5
    pheyer  
    OP
       2016-05-09 17:09:26 +08:00
    @wjh3936 是够麻烦的
    wjh3936
        6
    wjh3936  
       2016-05-09 17:12:13 +08:00
    @pheyer 所以最好的方法还是在注释里面加上作者的支付宝 [逃
    inmyfree
        7
    inmyfree  
       2016-05-09 17:15:48 +08:00
    specita
        8
    specita  
       2016-05-09 17:16:45 +08:00
    可以组织一个,刚在 github 上看到一个源码注释的,不过是 android 的 https://github.com/LittleFriendsGroup/AndroidSdkSourceAnalysis
    LZ 的意思应该是这种吧
    maddot
        9
    maddot  
       2016-05-09 17:18:01 +08:00
    采取 stackoverflow 的形式来组织更好,比如遇到某行代码不懂,就对那行代码提出问题,然后就等别人来回答, github 再把这些问题与答案按项目聚集在一起,就成了 github 版的 stackoverflow
    zztt168
        10
    zztt168  
       2016-05-09 17:20:56 +08:00 via iPhone
    楼主创意很好,我觉得做个类似的 wiki 就能够实现注释功能。我觉得是很有意义的事情。
    代码翻译可能又是另外一个产品了,可能难度更大一些。
    pheyer
        11
    pheyer  
    OP
       2016-05-09 17:24:20 +08:00
    @specita 能写成文档当然更好啦,有大局观,可以说是注释的副产品。但是它没有把注释的代码集中起来,每个人的文章又都是分散的
    pheyer
        12
    pheyer  
    OP
       2016-05-09 17:26:03 +08:00
    开源代码团队注释还有一个问题是,如果原始开源代码有更新,那么合并最新的代码时,注释的代码有可能更容易造成冲突
    LMkillme
        13
    LMkillme  
       2016-05-09 17:32:16 +08:00
    两三年前,在 V2 这边就看见有人做了个网站做这事,好像叫 codewa ,不过现在好像已经关了
    pheyer
        14
    pheyer  
    OP
       2016-05-09 17:42:15 +08:00
    @LMkillme 原来早就有人想到了啊,我找到了,没关,初衷也是一样,想降低阅读开源代码的难度,不过他的不叫注释,叫批注。 https://www.v2ex.com/t/95902?p=1http://codewa.com/。
    不过觉得这种还是公开的代码管理平台做这种事比较容易一些,关键是要有人组织才行
    hitmanx
        15
    hitmanx  
       2016-05-09 18:20:27 +08:00
    能做成肯定是大功一件,但是感觉烂尾的可能性挺高..
    yangxin0
        16
    yangxin0  
       2016-05-10 09:55:25 +08:00 via iPhone
    没得背景的强撸某个源代码只有灰飞烟灭,注不注释都一样
    ManKane
        17
    ManKane  
       2016-05-10 12:22:50 +08:00
    支持 LZ 这种想法,如果开干,我愿意贡献一点绵薄之力!
    DT27
        18
    DT27  
       2016-05-10 13:41:16 +08:00
    什么时候学习能直接输入大脑里就好了。。。
    innoink
        19
    innoink  
       2016-05-11 02:45:22 +08:00
    翻译其实是平台移植??
    大项目光看注释没啥用,因为设计思路和程序流程肯定和你看注释的流程不一样,有这工夫还不如写个《 xxx 源码剖析》
    pheyer
        20
    pheyer  
    OP
       2016-05-11 08:54:39 +08:00 via iPhone
    @innoink 是平台移植,这个更准确
    关于   ·   帮助文档   ·   博客   ·   API   ·   FAQ   ·   实用小工具   ·   2551 人在线   最高记录 6679   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 28ms · UTC 15:39 · PVG 23:39 · LAX 07:39 · JFK 10:39
    Developed with CodeLauncher
    ♥ Do have faith in what you're doing.