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

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

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

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

    第 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   ·   我们的愿景   ·   实用小工具   ·   5183 人在线   最高记录 6543   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 46ms · UTC 09:31 · PVG 17:31 · LAX 02:31 · JFK 05:31
    Developed with CodeLauncher
    ♥ Do have faith in what you're doing.