weo0
V2EX  ›  问与答

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

  •  
  •   weo0 · May 29, 2019 · 5369 views
    This topic created in 2723 days ago, the information mentioned may be changed or developed.

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

    Supplement 1  ·  May 29, 2019
    手残打错了,是行尾注释,阿里规约说不要用行尾注释。
    11 replies  •  2019-05-29 15:30:16 +08:00
    CSGO
    CSGO
    May 29, 2019
    1
    󠀡
    smeraldo
    smeraldo
    May 29, 2019
    2
    然而我没看到规约里有这么说过啊
    gogotanc
    gogotanc
    May 29, 2019 via Android
    3
    是行尾吧,
    Aresxue
    Aresxue
    May 29, 2019❤️1
    4
    可以行位注释,但是成员变量建议用文本注释,因为文本注释是可以被 javadoc 提取出来的,在生成的文档中会有体现,而行位的就没了。
    mapper
    mapper
    May 29, 2019
    5
    行尾吧? 主要是为了规范,不然一会行级注释,一会行尾注释多了之后就很乱 。
    weo0
    weo0
    OP
    May 29, 2019
    6
    @mapper 是行尾,手残打错了
    Raisu
    Raisu
    May 29, 2019
    7
    我也不推荐
    nekoneko
    nekoneko
    May 29, 2019
    8
    个人习惯不喜欢行尾注释。注释和代码放一行我会下意识看代码,然后就不看注释了
    uxstone
    uxstone
    May 29, 2019
    9
    那么问题来了 注释写代码上面还是代码下面?
    weo0
    weo0
    OP
    May 29, 2019
    10
    @uxstone 我感觉应该不写,哈哈哈哈
    weo0
    weo0
    OP
    May 29, 2019
    11
    @CSGO 卧槽,这才看到,居然同款头像
    About   ·   Help   ·   Advertise   ·   Blog   ·   API   ·   FAQ   ·   Privacy   ·   Solana   ·   4919 Online   Highest 6679   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 43ms · UTC 02:40 · PVG 10:40 · LAX 18:40 · JFK 21:40
    ♥ Do have faith in what you're doing.