关于阿里代码规约的不能使用行位注释的疑问 - V2EX
V2EX = way to explore
V2EX 是一个关于分享和探索的地方
现在注册
已注册用户请  登录
weo0
V2EX    问与答

关于阿里代码规约的不能使用行位注释的疑问

  •  
  •   weo02019-05-29 11:44:28 +08:00 4684 次点击
    这是一个创建于 2331 天前的主题,其中的信息可能已经有所发展或是发生改变。

    个人感觉行位注释完全没啥问题,为啥规约要求不能行位注释,求大佬解释一下。

    第 1 条附言    2019-05-29 14:47:19 +08:00
    手残打错了,是行尾注释,阿里规约说不要用行尾注释。
    11 条回复    2019-05-29 15:30:16 +08:00
    CSGO
        1
    CSGO  
       2019-05-29 12:03:37 +08:00
    smeraldo
        2
    smeraldo  
       2019-05-29 12:45:07 +08:00
    然而我没看到规约里有这么说过啊
    gogotanc
        3
    gogotanc  
       2019-05-29 13:55:24 +08:00 via Android
    是行尾吧,
    Aresxue
        4
    Aresxue  
       2019-05-29 14:08:52 +08:00   1
    可以行位注释,但是成员变量建议用文本注释,因为文本注释是可以被 javadoc 提取出来的,在生成的文档中会有体现,而行位的就没了。
    mapper
        5
    mapper  
       2019-05-29 14:21:52 +08:00
    行尾吧? 主要是为了规范,不然一会行级注释,一会行尾注释多了之后就很乱 。
    weo0
        6
    weo0  
    OP
       2019-05-29 14:48:30 +08:00
    @mapper 是行尾,手残打错了
    Raisu
        7
    Raisu  
       2019-05-29 15:00:55 +08:00
    我也不推荐
    nekoneko
        8
    nekoneko  
       2019-05-29 15:11:30 +08:00
    个人习惯不喜欢行尾注释。注释和代码放一行我会下意识看代码,然后就不看注释了
    uxstone
        9
    uxstone  
       2019-05-29 15:28:04 +08:00
    那么问题来了 注释写代码上面还是代码下面?
    weo0
        10
    weo0  
    OP
       2019-05-29 15:29:47 +08:00
    @uxstone 我感觉应该不写,哈哈哈哈
    weo0
        11
    weo0  
    OP
       2019-05-29 15:30:16 +08:00
    @CSGO 卧槽,这才看到,居然同款头像
    关于     帮助文档     自助推广系统     博客     API     FAQ     Solana     948 人在线   最高记录 6679       Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 24ms UTC 19:21 PVG 03:21 LAX 12:21 JFK 15:21
    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