zoukankan      html  css  js  c++  java
  • Python编码规范08-注释--代码注释

    1、 块注释

    “#”号后空一格,段落间用空行分开(同样需要“#”号)。

    # 块注释
    # 块注释
    #
    # 块注释
    # 块注释

    2、 行注释

    至少使用两个空格和语句分开,注意不要使用无意义的注释。

    # 正确的写法
    x = x + 1  # 边框加粗一个像素
    
    # 不推荐的写法(无意义的注释)
    x = x + 1 # x加1

    3、 建议

    在代码的关键部分(或比较复杂的地方), 能写注释的要尽量写注释。

    比较重要的注释段, 使用多个等号隔开, 可以更加醒目, 突出重要性。

    app = create_app(name, options)
    
    
    # =====================================
    # 请勿在此处添加 get post等app路由行为 !!!
    # =====================================
    
    
    if __name__ == '__main__':
        app.run()

    4、 TODO注释

    TODO注释应该在所有开头处包含"TODO"字符串, 紧跟着是用括号括起来的你的标识符. 然后是一个可选的冒号. 接着必须有一行注释, 解释要做什么.

    如果你的TODO是"将来做某事"的形式, 那么请确保你包含了一个指定的日期或者一个特定的事件("等到所有的客户都可以处理XML请求就移除这些代码").

    # TODO(kl@gmail.com): Use a "*" here for string repetition.
    # TODO(Zeke) Change this to use relations.
  • 相关阅读:
    xml解析
    File
    IO操作
    Json解析
    JNI字段描述符
    Android JNI get Context
    快速排序
    Android Scroller与computeScroll的调用机制关系
    Android 更新视图函数ondraw() 和dispatchdraw()的区别
    Android Studio 两个包里的类冲突
  • 原文地址:https://www.cnblogs.com/mazhiyong/p/12508768.html
Copyright © 2011-2022 走看看