python注释及命名规范

注释

'''
这是多行注释
'''
"""
这也是多行注释
"""
print("hello,world")
#这是单行注释

函数和方法

  • Args:

    • 列出每个参数的名字, 并在名字后使用一个冒号和一个空格, 分隔对该参数的描述.如果描述太长超过了单行80字符,使用2或者4个空格的悬挂缩进(与文件其他部分保持一致). 描述应该包括所需的类型和含义. 如果一个函数接受*foo(可变长度参数列表)或者**bar (任意关键字参数), 应该详细列出*foo和**bar.
  • Returns: (或者 Yields: 用于生成器)
    • 描述返回值的类型和语义. 如果函数返回None, 这一部分可以省略.
  • Raises:
    • 列出与接口有关的所有异常.
def fetch_bigtable_rows(big_table, keys, other_silly_variable=None):
    """Fetches rows from a Bigtable.

    Retrieves rows pertaining to the given keys from the Table instance
    represented by big_table.  Silly things may happen if
    other_silly_variable is not None.

    Args:
        big_table: An open Bigtable Table instance.
        keys: A sequence of strings representing the key of each table row
            to fetch.
        other_silly_variable: Another optional variable, that has a much
            longer name than the other args, and which does nothing.

    Returns:
        A dict mapping keys to the corresponding table row data
        fetched. Each row is represented as a tuple of strings. For
        example:

        {'Serak': ('Rigel VII', 'Preparer'),
         'Zim': ('Irk', 'Invader'),
         'Lrrr': ('Omicron Persei 8', 'Emperor')}

        If a key from the keys argument is missing from the dictionary,
        then that row was not found in the table.

    Raises:
        IOError: An error occurred accessing the bigtable.Table object.
    """
    pass

class SampleClass(object):
    """Summary of class here.

    Longer class information....
    Longer class information....

    Attributes:
        likes_spam: A boolean indicating if we like SPAM or not.
        eggs: An integer count of the eggs we have laid.
    """

    def __init__(self, likes_spam=False):
        """Inits SampleClass with blah."""
        self.likes_spam = likes_spam
        self.eggs = 0

    def public_method(self):
        """Performs operation blah."""

块注释和行注释

# We use a weighted dictionary search to find out where i is in
# the array.  We extrapolate position based on the largest num
# in the array and the array size and then do binary search to
# get the exact number.

if i & (i-1) == 0:        # True if i is 0 or a power of 2.

命名规范

  1. 单下划线(_)开头表示模块变量或函数是protected的(使用from module import *时不会包含).
  2. 用双下划线(__)开头的实例变量或方法表示类内私有.
类型 规范 示例
模块 全小写,单词间使用下划线连接 my_tools
全小写,单词间使用下划线连接 my_package
类名 每个单词首字母大写 BinaryTree
函数 全小写,单词间使用下划线连接 quick_sort()
变量 全小写,单词间使用下划线连接 total_num
常量 全大写,单词间使用下划线连接 MAX_NUM

详细参见Google 开源项目风格指南

原文地址:https://www.cnblogs.com/redo19990701/p/11456754.html

时间: 2024-10-11 23:13:03

python注释及命名规范的相关文章

项目复习期总结3:CSS引入方式,注释,命名规范,背景,行高,文本属性

目录: 1.CSS注释的书写 怎么写?好处? 2.CSS引入方式  各种的优缺点 3.选择器的写法与选择器的优先级 4.CSS命名规范 5.背景,行高 6.文本(text与font开头)等所有属性 ① CSS注释书写规范: 1.单行注释:    直接写在属性值的后面,如: ① .search{ border:1pxsolid#fff;/*定义搜索输入框边框*/ background:url(../images/icon.gif)no-report#333;/*定义搜索框的背景*/ } ② .wr

python 变量的命名规范

对于python变量的命名,我们可以遵循以下规范: 比如说,如果信息是姓名,那么变量可以命名为name:如果信息是数字,那么变量名则应该叫做number. 很多新手在刚入门的时候会习惯给变量命名为a.b.c等英文字母.这样的变量名会让你无法从诸多信息中分辨出变量里装的东西是什么,这无异于给自己的孩子取名叫做“张小红”.“王小明”,一下就淹没于茫茫人海之中了. 原文地址:https://www.cnblogs.com/cg-liusen/p/12245073.html

Python PEP 8 编码规范中文版

原文链接:http://legacy.python.org/dev/peps/pep-0008/ 转发链接:https://blog.csdn.net/ratsniper/article/details/78954852 Introduction 介绍 A Foolish Consistency is the Hobgoblin of Little Minds 尽信书则不如无书 Code lay-out 代码布局 Indentation 缩进 Tabs or Spaces 制表符还是空格 Max

Python 语法特点:注释/编写规则/命名规范

1.注释 1)单行注释     # 2) 多行注释   前后三个单引号或双引号   ‘’‘  ...  '''    """  ...""" 3)中文编码声明注释 # -*- coding:编码  -*- 或  # coding=编码 若采用UTF-8编码,则设置为urf-8;若使用GBK编码,则使用gbk 或cp936 2.代码缩进 使用冒号区分代码之间的层次. 四个空格或一个Tab键作为缩进.推荐用4个空格. 可以在IDE设置快捷键,进行缩进

python 命名规范

参考Google开源项目风格指南:https://zh-google-styleguide.readthedocs.io/en/latest/google-python-styleguide/contents/ 转载一下其中的命名规范: 命名 module_name, package_name, ClassName, method_name, ExceptionName, function_name, GLOBAL_VAR_NAME, instance_var_name, function_pa

【转】python变量命名规范

python源码和其他一些书籍,命名各种个性,没有一个比较统一的命名规范.于是总结了一些,供参考. 模块名: 模块应该使用尽可能短的.全小写命名,可以在模块命名时使用下划线以增强可读性.同样包的命名也应该是这样的,虽然其并不鼓励下划线. 主要是考虑模块名是与文件夹相对应的,因此需要考虑文件系统的一些命名规则的,比如Unix系统对大小写敏感,而过长的文件名会影响其在Windows\Mac\Dos等系统中的正常使用. 通常是小写字母,单词之间用_分割 ad_stats.py 包名: 和模块名一样 类

python 变量命名规范

python源码和其他一些书籍,命名各种个性,没有一个比较统一的命名规范.于是自己总结了一些,可供参考.模块名:小写字母,单词之间用_分割ad_stats.py 包名:和模块名一样 类名:单词首字母大写AdStatsConfigUtil 全局变量名(类变量,在java中相当于static变量):大写字母,单词之间用_分割NUMBERCOLOR_WRITE 普通变量:小写字母,单词之间用_分割this_is_a_var 实例变量:以_开头,其他和普通变量一样_price    _instance_

python 中变量的命名规范

出自:http://www.diybl.com/course/3_program/python/20111130/563643.html 模块名: 小写字母,单词之间用_分割 ad_stats.py 包名: 和模块名一样 类名: 单词首字母大写 AdStats ConfigUtil 全局变量名(类变量,在java中相当于static变量): 大写字母,单词之间用_分割 NUMBER COLOR_WRITE 普通变量: 小写字母,单词之间用_分割 this_is_a_var 实例变量: 以_开头,

Google Python 命名规范

Google Python命名规范 module_name,  模块 package_name,  包 ClassName,  类 method_name,  方法 ExceptionName,   异常 function_name,  函数 GLOBAL_VAR_NAME, 全局变量 instance_var_name,  实例变量 function_parameter_name,   参数 local_var_name.  局部变量:在方法体中声明的变量   类 总是使用首字母大写单词串.如