发现同事们很喜欢写这样的代码注释... - V2EX
Home Sign Up Sign In
请不要在回答技术问题时复制粘贴 AI 生成的内容
gangsta

发现同事们很喜欢写这样的代码注释...

  •   
  •   gangsta Apr 3, 2014 10794 views
    This topic created in 4449 days ago, the information mentioned may be changed or developed.
    //************* xxx function START *************//

    code block...

    //************* xxx function END *************//

    还有一个是维护类代码的注释,在我待过的公司,以及被外派,出差,各种onsite/offshore合作过的公司中,同样发现很多人都喜欢这么写...

    先把bug代码块注释掉,然后...

    //************* modified by xxx at 2013-02-14 for xxx reason START *************//

    code block...

    //************* modified by xxx at 2013-02-14 for xxx reason END *************//
  • XXX
  • 注释
    53 replies    1970-01-01 08:00:00 +08:00
    zoowii
        1
    zoowii  
       Apr 3, 2014
    我先注释，跑通没问题的话第二天就删掉
    ivenvd
        2
    ivenvd  
       Apr 3, 2014
    不会用版本管理的同事……
    muzuiget
        3
    muzuiget  
       Apr 3, 2014
    我也很烦这种到处留名的注释，大块无用代码注释，靠，用版本管理的话，什么都清清楚楚了。
    lyragosa
        4
    lyragosa  
       Apr 3, 2014
    我也很喜欢用这种注释
    nicai000
        5
    nicai000  
       Apr 3, 2014
    xxx blame多好用的
    bengol
        6
    bengol  
       Apr 3, 2014   1
    比用中文注释好多了，各种编码切换～
    wvidc
        7
    wvidc  
       Apr 3, 2014
    很好啊 方便二次开发 容易上手
    wizardoz
        8
    wizardoz  
       Apr 3, 2014
    还有一种，要在函数注释头中写上调用了哪些函数，以及被哪些函数调用。各种蛋疼。
    likai
        9
    likai  
       Apr 3, 2014
    我怎么觉得不错，别人接手一看明
    lu18887
        10
    lu18887  
       Apr 3, 2014
    在LINUX 下VI编程，这种注释已经是很友好的了！版本控制工具，在图形化界面下很nice，但是在命令行下就没那么明了了。
    lemonlwz
        11
    lemonlwz  
       Apr 3, 2014
    如何一行注释都没有,会否习惯呢?
    wlh
        12
    wlh  
       Apr 3, 2014
    我自己的Blog代码都这么写……下次一看就知道，否则经常忘了这块是什么用的要想半天
    Pixeller
        13
    Pixeller  
       Apr 3, 2014
    挺好的, lz你哪天看到一大段一大段被别人改, 如果别人没有注释, 谁知道哪里被框掉了? 小改动看看blame还行, 日积月累, 还能看得过来?
    FrankFang128
        14
    FrankFang128  
       Apr 3, 2014
    WebStorm 自动添加 function separator，这个功能还是有点用的
    DogonLin
        15
    DogonLin  
       Apr 3, 2014
    做SAP的时候里面基本都是这种注释。。。。
    NetCobra
        16
    NetCobra  
       Apr 3, 2014
    我不喜欢这种注释，这种活应该是版本管理的功能，不应该用注释来干。
    raincious
        17
    raincious  
       Apr 3, 2014
    @lu18887 我一直以为git branch new_branch和git add new_file.c是在命令行下敲的。
    bsbgong
        18
    bsbgong  
       Apr 3, 2014
    1. 这注释很好，我也喜欢这样写的，不过现在的team guidelines里不许这样写了。看各团队自己的规范，大家一致遵守就好。
    2. 程序注释就没必要吐槽了。个人趣味不同，你觉得不好用的别人觉得好用。
    wdlth
        19
    wdlth  
       Apr 3, 2014
    我一般用DOC型注释
    /**
    * 描述
    *
    * @author 作者
    * @version 版本
    * @package 包
    *
    */
    这类的
    wklken
        20
    wklken  
       Apr 3, 2014
    刚毕业那会在的公司很喜欢用，因为代码管理混乱，特别是一些不得不改的公用部分
    声明的目的是界定说这块代码是xxx加的，没事别乱改，要改去找当事人

    不过好久没见到了......
    slixurd
        21
    slixurd  
       Apr 3, 2014
    xxx modify没啥必要，但是修改原因还是很有意义的
    函数顶部外加doc型注释，说清楚参数含义，调用方式
    我是没见过几个人看源代码开着git blame来看的，又没高亮又不方便跳转
    用来差错定位是谁改错用git blame还差不多
    viator42
        22
    viator42  
       Apr 3, 2014
    这种注释方式很好用.
    尤其是在行数很多的文件里分隔不同的功能模块,看起来一目了然.
    做版本管理的话太原始了.
    以前还有必须是80个字符的规定.
    ichou
        23
    ichou  
       Apr 3, 2014
    html 和 css 里面才用这种 start end 的注释
    其他的都严格按照 DOC 来写
    我会说我曾经在自己写的类注释里面还画了一个 逻辑流程图示 么？小伙伴看到那个注释可带劲儿了
    p2007
        24
    p2007  
       Apr 3, 2014
    知足吧，这已经很好了，至少还可以看出来以前是因为什么原因修改了代码。何况有时也无法连接到版控。
    emanonwzy
        25
    emanonwzy  
       Apr 3, 2014
    我待的第一家公司也是这样，据说是为了出bug可以找到修改的人。。。
    xiaowangge
        26
    xiaowangge  
       Apr 3, 2014 via Android
    昨天刚接触到的: package-info.java

    ,-)
    loading
        27
    loading  
       Apr 3, 2014 via iPhone
    html喜欢用start和end
    lu18887
        28
    lu18887  
       Apr 3, 2014
    @raincious 看公司把，互联网公司用GIT的可能性大一些，传统的都还是SVN。
    tonic
        29
    tonic  
       Apr 3, 2014
    @lu18887 svn不也是命令敲么... svn co, svn ci -m, svn sw --force, svn merge...
    lu18887
        30
    lu18887  
       Apr 3, 2014
    @tonic 但我从来没用命令行的svn看过log ……
    raincious
        31
    raincious  
       Apr 3, 2014
    @lu18887

    其实是历史原因哈。不过另外SVN有一个巨大的好处，就是你想要commit，必须commit到服务器上，这样大家都能看到，不会有本地堆积了一堆commit之后，push时的冲突。
    caizeng
        32
    caizeng  
       Apr 3, 2014
    我觉得这是一个好习惯
    janxin
        33
    janxin  
       Apr 3, 2014
    以前学VC和VB的时候，挺常见的...
    Livid
        34
    Livid  
    MOD
    PRO
       Apr 3, 2014   1
    最好不要在线上的代码里留注释掉的代码。这个东西就是读代码的人的精神负担和改代码的人的定时炸弹。

    这些代码应该加一个容易搜索的关键字留在版本控制历史里。
    hkongm
        35
    hkongm  
       Apr 3, 2014
    多好的习惯啊。
    如果没有版本管理这样是最好的了。
    还有上面有的同学说版本管理，有几个人认真填写commit comment的？我认识的，除了我一个人，没人认真写。。。
    tonic
        36
    tonic  
       Apr 3, 2014
    @lu18887 不过也是... 因为太难看了= =#
    lightening
        37
    lightening  
       Apr 3, 2014   1
    我们公司的代码规范说无特殊情况禁止写注释…… 如果你的代码要注释才能看懂，说明代码写坏了，回去重构。另外说明性质的语句放在 git commit message 里供人 blame 看。
    jsonline
        38
    jsonline  
       Apr 3, 2014
    If you see such comments in someone's code, it may imply that
    1. the function is bloated.
    2. he takes no advantage of SVN or GIT
    icyalala
        39
    icyalala  
       Apr 3, 2014
    1.代码是给人看的，总有某段代码不容易被理解，加上注释会更友好、理解更迅速。
    不加注释能不能看懂是另外一回事了。
    2.modified by xxx at xxx这种。。只能说版本控制没用好。
    wuxqing
        40
    wuxqing  
       Apr 3, 2014
    modified by xxx at xxx
    这种没啥问题，有的时候代码不是本部门维护，可能会有第三方。版本管理不一定好使
    cashplk
        41
    cashplk  
       Apr 3, 2014
    以前呆过一个公司，他们要求就是这样的。符合规则就好。好坏勿论。
    wwek
        42
    wwek  
       Apr 3, 2014
    冗余点的注释 没关系。只要不是产生混淆的注释。

    那种没注释的才是真坑爹
    lidonghao
        43
    lidonghao  
       Apr 3, 2014
    modified by xxx @ V1.x.x
    在最上方写版本的相关信息
    loryyang
        44
    loryyang  
       Apr 3, 2014
    我遵守：无用代码就删掉的原则。因为无用代码包括注释会对其他接收人造成混淆和精神负担。一个是看着实在是费劲，我看过连续上百行被注释掉的代码，实在是崩溃了。有了版本管理器之后，删掉的代码完全可以删掉了。另外一个是可能会造成混淆，注释什么的如果需要，就要跟着代码的修改而不断升级，否则慢慢的，注释就废掉了，变成一种无用的负担。
    所以建议是少加注释，无用代码全删，代码尽量自解释，命名要长，逻辑尽量简单。复杂的内容才加注释
    likuku
        45
    likuku  
       Apr 4, 2014
    不是任何地方都有版本管理，很多时候可能需要直接面对服务器操作，可能还没带自己工作电脑，哪里去搞版本库？直接写源码里最方便了。
    kneep
        46
    kneep  
       Apr 4, 2014 via iPhone
    最烦这种到此一游的注释了，水平差的人基本都不知道有blame，水平差的人也不信任git或svn能做得更好，他们除了checkout和chechin，啥都不会，这样的人充斥了各个公司。
    Debiancc
        47
    Debiancc  
       Apr 4, 2014
    //声明 变量fuck
    var fuck={};
    azhao
        48
    azhao  
       Apr 4, 2014
    写法可以更简洁一些，但写是有必要的，很多人改代码的时候可不会去看你的svn log才会改
    poke707
        49
    poke707  
       Apr 6, 2014 via Android
    这也是解决问题一种办法，可能是历史原因导致不能做得更好。所以在我们非当事人或者是全新开始的话，看起来有点挫
    entertainyou
        50
    entertainyou  
       Apr 6, 2014 via iPad
    @bengol bream modify
    smilerhaha
        51
    smilerhaha  
       Apr 7, 2014
    支持 @wdlth的写法
    leavic
        52
    leavic  
       Apr 7, 2014
    我以前也喜欢写XXX Start,XXX End,
    不过现在比较少了,函数名写清楚点什么事都没了.
    lygmqkl
        53
    lygmqkl  
       Apr 7, 2014
    bug资料写入代码。。。 那么version control 的角色在哪里？ 一个月更新2次，或者说3个月后相同功能就砍了，那么在这类代码的投入是不是太铺张了，或许写 win ios这样的系统需要这样吧。一般项目觉得没必要。
    About     Help     Advertise     Blog     API     FAQ     Solana     5452 Online   Highest 6679       Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 202ms UTC 08:26 PVG 16:26 LAX 01:26 JFK 04:26
    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