HTML5技术

如何写出好代码 - JackieZheng(2)

字号+ 作者:H5之家 来源:H5之家 2017-03-28 08:00 我要评论( )

因为有很多判断,相信你应该会看一眼注释来帮助自己更好的理解这段代码,但是仔细一推敲,发现代码中的逻辑应该是isAdmin为false的时候,才会去获取isGroup的值,而非像注释中提到为true的时候。 有时候我们需要注

因为有很多判断,相信你应该会看一眼注释来帮助自己更好的理解这段代码,但是仔细一推敲,发现代码中的逻辑应该是isAdmin为false的时候,才会去获取isGroup的值,而非像注释中提到为true的时候。

  • 有时候我们需要注释
    必要的Javadoc,好比
  • /** *get Person entity by id */ ...

    帮助澄清信息,比如

    //example: ...domain + childDomain + version + id...

    警示信息,对于一些代码的使用有些特殊场景要求,可以通过注释标示出来。
    TODO 这个大家应该会经常使用吧,用来标记一些我们即将要实现的功能或者带扩展的功能。

    今天就到这,后面有机会再整理。
    如果您觉得阅读本文对您有帮助,请点一下“推荐”按钮,您的“推荐”将是我最大的写作动力!如果您想持续关注我的文章,请扫描二维码,关注JackieZheng的微信公众号,我会将我的文章推送给您,并和您一起分享我日常阅读过的优质文章。

    posted @

     

    1.本站遵循行业规范,任何转载的稿件都会明确标注作者和来源;2.本站的原创文章,请转载时务必注明文章作者和来源,不尊重原创的行为我们将追究责任;3.作者投稿可能会经我们编辑修改或补充。

    相关文章
    • 关于li标签之间的间隔如何消除! - 野望之风

      关于li标签之间的间隔如何消除! - 野望之风

      2017-03-25 12:01

    • 如何脱颖而出? - 一个北漂的女孩

      如何脱颖而出? - 一个北漂的女孩

      2017-03-20 11:00

    • 如何使用Vue2做服务端渲染 - 莫扬的天空

      如何使用Vue2做服务端渲染 - 莫扬的天空

      2017-03-18 15:00

    • 说说如何用js实现一个模板引擎 - WAxes

      说说如何用js实现一个模板引擎 - WAxes

      2017-03-14 17:00

    网友点评
    >