单行注释,以“/ /”包裹注释内容,注意内容与注释符之间有头尾的空格隔开。例如:

    1. /**
    2. * 注释内容
    3. * @author xxx
    4. */
    5. 错误示范:
    6. /*
    7. 注释符第一行应该是“/**”,每一行开头是“* ”
    8. */
    9. /**
    10. *每一行注释内容与开头的“*”之间要有空格
    11. /**
    12. * 注释符结尾只需要“*/”即可
    13. **/

    对于文件而言,最关键的信息在于代码维护者是谁?这份文件是什么时候的版本?文件内容包含什么? 因此推荐的注释模板如下:

    当某个模块有较多分类/拓展的情况,需要一定的说明才能正确使用时,推荐为它加上模块级注释。 模块级注释类似面向对象编程里对某个类进行注释,说明它的作用、使用时有什么依赖、提供哪些方法、class如何嵌套。 以下是一个推荐模板:

    1. /**
    2. * .qm_list_item
    3. * + .qm_list_item_BorderNone 不显示item底部的分隔线
    4. * + .qm_list_item_Accessory 在item右边显示向右箭头
    5. * + .qm_list_item_Style2 标题、副标题上下排列
    6. *
    7. * > [.qm_list_item_control] 可选。在列表左边显示一个控制控件,例如checkbox、radio等
    8. * > .qm_list_item_textWrapper 包裹item文字内容的容器,内部只能摆放文字
    9. * > .qm_list_item_title item的标题,默认为黑色
    10. * > .qm_list_item_subtitle item的副标题,默认会灰色
    11. *
    12. */
    13. .qm_list_item {
    14. ...
    15. border-bottom:1px solid #000;
    16. ...
    17. }
    18. .qm_list_item_BorderNone {
    19. border-bottom:none;

    当某句语句比较特殊,或实现方式与标准的实现方式不同,为了避免阅读时产生疑惑,就必须为语句添加说明。 行内注释紧跟写在需要注释的语句的后面,语句和注释之间不需要有空格。行内注释以“/ ”开始,以“ /”结束。注意开头、结尾均有空格隔开注释内容。

    .layout_left {
      float: left;
      margin-right: 10px;
    }
    .layout_right {
      overflow: hidden; /* 产生BFC,隔开左右两部分内容 */
    }