让别人读懂你的代码 - V2EX
V2EX = way to explore
V2EX 是一个关于分享和探索的地方
现在注册
已注册用户请  登录
xhacker
V2EX    随想

让别人读懂你的代码

  •  
  •   xhacker 2010-10-23 23:46:47 +08:00 6390 次点击
    这是一个创建于 5534 天前的主题,其中的信息可能已经有所发展或是发生改变。
    原先一直是自己写东西。

    最近加入了一些开源项目。
    自己的一些所谓的“项目”也有了别人接手。

    别人的代码对我来说总是恐怖的。
    相信我的代码对别人来说也是恐怖的。

    ……
    所以,
    能让别人读懂你的代码,
    估计是最高境界了。
    7 条回复    1970-01-01 08:00:00 +08:00
    no2x
        1
    no2x  
       2010-10-23 23:57:58 +08:00
    注释 是必须也是很重要的。开发文档,最好有文件简介。
    darcy
        2
    darcy  
       2010-10-24 00:09:37 +08:00
    的确,要想代码写得优雅不是一朝一夕的事情
    FRHong
        3
    FRHong  
       2010-10-24 03:24:59 +08:00 via iPhone
    http://liuming.javaeye.com/blog/776890

    You might be interested in this :)
    ratazzi
        4
    ratazzi  
       2010-10-24 11:03:00 +08:00
    现在觉得命名非常的重要,好的命名基本上不需要什么注释,主要是针对 PHP 来说,比如 Magento 的代码比起那些 vanilla 好读很多。
    Sam
        5
    Sam  
       2010-10-24 13:03:09 +08:00
    想起那个搞笑的注释:
    只有上帝和我看得懂。
    现在,只有上帝看得懂了。


    刚学编程的时候写的代码,从不注释,过了几天,自己都看不懂了。
    lik
        6
    lik  
       2010-10-24 15:00:46 +08:00 via Android
    编程就是和机器以及人类交流(项目合作者、几天后的自己)啊。
    cellsea
        7
    cellsea  
       2011-01-12 12:40:25 +08:00
    为什么我从来都看得懂自己的代码呢? 我从来不写注释的。。。 是我写的代码太简单了吧??。。。
    关于     帮助文档     自助推广系统     博客     API     FAQ     Solana     4905 人在线   最高记录 6679       Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 24ms UTC 09:40 PVG 17:40 LAX 01:40 JFK 04:40
    Do have faith in what you're doing.
    ubao msn snddm index pchome yahoo rakuten mypaper meadowduck bidyahoo youbao zxmzxm asda bnvcg cvbfg dfscv mmhjk xxddc yybgb zznbn ccubao uaitu acv GXCV ET GDG YH FG BCVB FJFH CBRE CBC GDG ET54 WRWR RWER WREW WRWER RWER SDG EW SF DSFSF fbbs ubao fhd dfg ewr dg df ewwr ewwr et ruyut utut dfg fgd gdfgt etg dfgt dfgd ert4 gd fgg wr 235 wer3 we vsdf sdf gdf ert xcv sdf rwer hfd dfg cvb rwf afb dfh jgh bmn lgh rty gfds cxv xcv xcs vdas fdf fgd cv sdf tert sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf shasha9178 shasha9178 shasha9178 shasha9178 shasha9178 liflif2 liflif2 liflif2 liflif2 liflif2 liblib3 liblib3 liblib3 liblib3 liblib3 zhazha444 zhazha444 zhazha444 zhazha444 zhazha444 dende5 dende denden denden2 denden21 fenfen9 fenf619 fen619 fenfe9 fe619 sdf sdf sdf sdf sdf zhazh90 zhazh0 zhaa50 zha90 zh590 zho zhoz zhozh zhozho zhozho2 lislis lls95 lili95 lils5 liss9 sdf0ty987 sdft876 sdft9876 sdf09876 sd0t9876 sdf0ty98 sdf0976 sdf0ty986 sdf0ty96 sdf0t76 sdf0876 df0ty98 sf0t876 sd0ty76 sdy76 sdf76 sdf0t76 sdf0ty9 sdf0ty98 sdf0ty987 sdf0ty98 sdf6676 sdf876 sd876 sd876 sdf6 sdf6 sdf9876 sdf0t sdf06 sdf0ty9776 sdf0ty9776 sdf0ty76 sdf8876 sdf0t sd6 sdf06 s688876 sd688 sdf86