Python冷知识-优雅的文档属性

Python是一门学习成本低但是使用场景广泛的语言，0基础2周左右就可以进行简单的脚本编写，但也正是因为这个原因，导致很多小伙伴的Python代码比较粗糙，那么我们来聊聊使用文档属性让Python代码更加的优雅。

设置文档属性

作为一名程序员，无论写什么代码，注释都是一个好的习惯，良好的注释不但对协作的小伙伴有好处，对捋清楚开发思路和代码维护都是有很大帮助的，有没有小伙伴在一周之后再看自己的代码发现有点陌生....，但是不写注释并不会导致程序中断，所以，不写注释这件事他合法但是不道德。

Python本身是支持注释的，单行注释使用'#'号，多行注释使用三引号，这个很基础，除此之外，Python还提供了内置的文档属性__doc__来支持对于项目，脚本，功能的注释，并且通过内置的help方法可以进行文档属性的读取。我们来看一个案例：

1、设置一个目录，如下：

抛开功能，在当前项目的每一个文件对象的第一行添加字符串，就是文档字符串，比如：

(1) 对包文件添加

在包（目录）的__init__.py文件首行添加字符串就是当前包的文档属性值

utils/__init__.py

""" Python
utils 包负责这个项目所有公共的功能，包含
mt - 数据计算功能
"""
复制代码

(2) 对文件添加 在python文件首行添加字符串就是当前文件的文档属性值

utils/mt.py

"""
mt 实现了对项目数据计算的功能，包含了
fun1
class1
"""
复制代码

(3) 读类和函数添加

在类或者函数的语句块首位添加字符串，就是这个类或者函数的文档属性值

utils/mt.py

def fun1(num):
    """
    实现对num加密功能，使用方法：
    fun(num)
    num参数必须是一个字符串
    """
    pass

class Mt:
    """
    当前类会创建一个Mt对象，对象当中包含了
    mt.change 格式转换功能
    mt.set 队列元素存储功能
    mt.get 队列元素获取功能
    """
    def change(self,t):
        """
        格式转换功能,根据传入的t转换mt的格式
        返回新格式的mt
        """

    def set(self,k,v):
        """
        设置mt元素
        :param k: 元素键，可以使用字符串，数字
        :param v: 元素的值
        :return: 返回mt对象
        """

    def get(self,k):
        """
        获取mt的元素
        :param k: 元素键
        :return: 返回元素的值
        """
复制代码

使用文档属性

那么写好这些文档属性之后，怎么使用呢？两种方法：

1、直接调用__doc__属性

import utils
from utils import mt
print(utils.__doc__)
print(mt.__doc__)
复制代码

2、使用help命令，可以把这个方法完整的文档属性展示出来

from utils.mt import Mt

help(Mt)
复制代码

Python的文档属性不会影响代码的执行，但是对于代码的可读性和可维护性都有很大的帮助，所以还是很有必要写的，最后希望所有的小伙伴都会遇到写注释的小伙伴一起快乐的编程，还请各位大佬多多指点啊。