Python类的基本写法与注释风格介绍

class Dog(object):
	\"\"\"This is a dog class as example\"\"\"
	def __init__(self,name):
		\"\"\"This is initial funciton\"\"\"
		self.name = name
	
	def voice(self):
		\"\"\"Dog will speak as wangwang \"\"\"
		print(\'WangWangWang\')

class Dog(object):
	\"\"\"This is a dog class as example\"\"\"
	
	animal_kind = \'dog\'    #基本属性
	animal_legs = 4        #基本属性也建议写到初始化构造函数中去
	
	def __init__(self,name,age,params...):    #利用__init__(self,params)进行初始化
		\"\"\"This is initial funciton\"\"\"
		self.name = name
		self.age = age
		#还可以定义各种其他的属性，作为实例初始化时候将传进来的参数进行赋值
		self.__gender = \'male\'        #两个下划线开头是私有内部属性，只能在类内访问
	
	def __privateGender(self):
		\"\"\"This is pravate method\"\"\"
		print(\'This dog gender is %s\',self.__gender)	
	def voice(self):
		\"\"\"Dog will speak as wangwang \"\"\"
		print(\'WangWangWang\')
		print(self.__privateGender(self))
	def run(self):
		\"\"\"runing with legs\"\"\"
		print(\"This dog has %d legs to run\"%self.animal_legs)
	#定义一大堆各种各样的方法

class Husky(Dog):
	\"\"\"Husky inherent the Dog attris and method\"\"\"
	def __init__(self,name,age,color,params):
		Dog.__init__(self, name, age)   #利用Dog这个父类的初始化
		self.color = color              #子类中特定属性的初始化
	def jump(self):
		\"\"\"Husky special jump function\"\"\"
		print(\'This dog could jump jump\')
	
	def voice(self):
		\"\"\"重写覆盖父类的函数，实现自己的特殊的方法\"
		print(\'AoAoAoWu~~~~~~\')

# ref from:https://zh-google-styleguide.readthedocs.io/en/latest/google-python-styleguide/python_style_rules/
class MyDog(object):
    \"\"\"Summary of class here.        #1.首先一句话简短的总结这个类的功能和作，文档字符串需要用三引号包括
	
	# 对齐，空一行
	If the class has public attributes, they may be documented here
    in an ``Attributes`` section and follow the same formatting as a
    function\'s ``Args`` section. Alternatively, attributes may be documented
    inline with the attribute\'s declaration (see __init__ method below).
    Properties created with the ``@property`` decorator should be documented
    in the property\'s getter method.
   
    Longer class information....     #随后详细的说明类的细节
    Longer class information....     #类内部第一行的开始的文字都可以被__doc__
	
	# 空一行，开始写这个类的各个属性，包括数据类型和作用
    Attributes:
        likes_spam: A boolean indicating if we like SPAM or not.   #属性的声明，包括数据类型和作用，xxx类型的数据for/used to/ofxxx
        eggs: An integer count of the eggs we have laid.
    \"\"\"
    def __init__(self, likes_spam=False):
        \"\"\"Inits SampleClass with blah.\"\"\"
        # 下面是详细的例子
		\"\"\"Example of docstring on the __init__ method.
		
		# 对于初始化方法的说明
        The __init__ method may be documented in either the class level
        docstring, or as a docstring on the __init__ method itself.
        Either form is acceptable, but the two should not be mixed. Choose one
        convention to document the __init__ method and be consistent with it.
		
		# 对于初始化方法的一些记录
        Note:
            Do not include the `self` parameter in the ``Args`` section.
		
		# 初始化的参数输入，对于方法来说参数名(数据类型)：描述的格式来写
        Args:
            param1 (str): Description of `param1`.
            param2 (:obj:`int`, optional): Description of `param2`. Multiple
                lines are supported.
            param3 (:obj:`list` of :obj:`str`): Description of `param3`.
        \"\"\"
        self.likes_spam = likes_spam
        self.eggs = 0
	    # 输入参数的初始化
        self.attr1 = param1
        self.attr2 = param2
        self.attr3 = param3  #: Doc comment *inline* with attribute
        #: list of str: Doc comment *before* attribute, with type specified
        self.attr4 = [\'attr4\']
        self.attr5 = None
        \"\"\"str: Docstring *after* attribute, with type specified.\"\"\"
    def public_method(self):
        \"\"\"Performs operation blah.\"\"\"
        \"\"\"Summary line.   #第一行简写函数描述
	    
	    # 空一行，对齐详细描述
	    Extended description of function.
		
		# 空一行对齐，写args 的各个内容，变量名（类型）：描述
	    Args:
	        arg1 (int): Description of arg1
	        arg2 (str): Description of arg2
		
		# 空一行对齐，不同情况下的if else 返回值（类型）：描述
	    Returns:
	        int/float/bool dtype: Description of return value
	
	    \"\"\"

class Dog(object):
	\"\"\"
	This is a class for Dog 
	Dog class is the parents class of all dog, this class contain 
	general attributes of dog and some common function of dogs, such as
	num legs, the voice fucntion, the runing functions.
	
	Attributes:
		name: 	A string of dog\'s name
		kind: 	A string of dog\'s family
		age:  	A integer of dog years
		gender: A boolean gender of dog, male=1 of famle=0
		legs    A integer if dog\'s legs
		weight: A float of dogs weight
		size:   A string of dogs, one of big, middle, smal
	\"\"\"
	
	def __init__(self,args,gender,size):
		\"\"\"initialize dog class, all attributes pass in with args, which is a dict or indepent params
		Input contain dict and str params, also there is private attribute
		
		Args:
			args.name(str): dog name
			args.kind(str): dog family
			args.age(int) : dog age
			gender(bool)  : dog gender, male=1,famale=0
		args.weight(float): dog weight
			size(str)     : dog size
		\"\"\"
		self.name = args.name
		self.kind = args.kind
		self.age = args.age
		self.weight = args.weight
		
		# __legs(int) : dog legs,privite attribute, not the inputs params,写在前面用#做注释，不属于输入的参数的初始化
		self.__legs = 4  
		\"\"\"写在后面用三引号__legs(int)   : dog legs,privite attribute\"\"\"
		
		self.size = size
		self.gender = gender
		
	def voice(self,size):
		\"\"\"This is dog speak fucntion
	
		Different dog with different voice 
		which related to the size,age and kind
		Args:
			size(str): dog size
			age(int) : dog age
			kind(srt): dog kind
			
		Returns:
		    None, just print the voice
	    \"\"\"
		if size==\'big\':
			print(\'Big WangWang\')
		elif size ==\'middle\':
			print(\'M wang\')		
		elif size==\'small\':
			print(\'Miao\')
		
		# 附注：return 可从任意深度跳出函数，None

class MyClass:
  name = \'\'
  age = 0
  __weight = 0 #私有变量
  
  def __init__(self, n, a, w): #self必须作为函数的第一个参数
    self.name = n
    self.age = a
    self.__weight = w
  def speak(self):
    print(\'%s 说：我 %s 岁\'%(self.name, self.age))
x = MyClass(\'yao\', 10, 30)
x.speak()