美文网首页
VS 中常用的注释token

VS 中常用的注释token

作者: 魔人健太郎 | 来源:发表于2021-03-25 13:25 被阅读0次

    //VS 默认
    // HACK:
    // TODO:
    // UNDONE:
    // UnresolvedMergeConflict:

    //ReSharper 默认
    // throw new NotImplementedException
    // BUG:
    // TODO:

    //General 宇宙通用
    // TODO:
    // XXX:
    // FIXME:

    使用方法:
    VS TASKLIST 任务视图可以便捷的管理自己的注释
    Resharper可以在代码页中高亮,我们不使用,无视他。

    说明:
    TODO标记的内容必须在下次commit之前解决(不能在项目中保留任何TODO在每次提交前)
    UNDONE 不使用TODO而使用UNDONE来将此处的工作留给将来
    FIXME是已知道的BUG却还没解决的,可能用了workaround
    XXX 含义很丰富,在VS中感觉和 UNDONE 很类似,我使用XXX用作吐槽,INSTEAD来标记此处将来用别的组件替换的意义
    HACK是用了很不寻常、奇葩的方法实现的一段代码
    BUG 是ReSharper中自带的,感觉和FIXME重复了,所以不使用

    NOTE 不需要出现在任务视图,有提示开发者阅读代码时强制看注释的作用
    QUESTION 我自己不确定的东西
    INSTEAD 来标记此处将来用别的组件替换
    普通的注释,尽量做到解释为什么要这样做,而不需要解释在做什么,或者后者即为NOTE该出现的地方

    附:
    可以考虑根据需求将
    NOTE QUESTION INSTEAD FIXME 这些token添加到ReSharper
    FIXME 添加到VS TaskList

    相关文章

      网友评论

          本文标题:VS 中常用的注释token

          本文链接:https://www.haomeiwen.com/subject/swilhltx.html