python这样注释，让你的代码看起来更加的优雅

Posted 2021-09-26 autofelix

〝 古人学问遗无力，少壮功夫老始成 〞

python这样注释，让你的代码看起来更加的优雅，是不是常常感觉自己的python代码写出来，看起来特别的乱，虽然可以正常运行，但是在优雅性上似乎欠缺的很多，这篇文章主要教你，如何让你的python代码看起来更加的优雅与美观，常码字不易，出精品更难，没有特别幸运，那么请先特别努力，别因为懒惰而失败，还矫情地将原因归于自己倒霉。你必须特别努力，才能显得毫不费力。如果这篇文章能给你带来一点帮助，希望给飞兔小哥哥一键三连，表示支持，谢谢各位小伙伴们。

目录

一、注释欣赏

---

一、注释欣赏

• 这里有一段飞兔小哥哥自己常写的注释模版
• 这里主要分为表头注释、类注释、欢迎语以及方法注释
• 表头注释会标注这个项目的名称、文件名、项目作者、时间等基础信息
• 类注释会标注这个类主要用来做什么的
• 而方法注释则表示当前方法的作用

​​#!/usr/bin/env python
# encoding: utf-8
'''
#-------------------------------------------------------------------
#                   CONFIDENTIAL --- CUSTOM STUDios
#-------------------------------------------------------------------
#
#                   @Project Name : the desc of project
#
#                   @File Name    : main.py
#
#                   @Programmer   : autofelix
#
#                   @Start Date   : 2021/06/01 12:42
#
#                   @Last Update  : 2021/06/01 12:42
#
#-------------------------------------------------------------------
'''
import requests, os, platform, time
from Crypto.Cipher import AES
import multiprocessing
from retrying import retry

class M3u8:
    '''
     This is a main Class, the file contains all documents.
     One document contains paragraphs that have several sentences
     It loads the original file and converts the original file to new content
     Then the new content will be saved by this class
    '''
    def __init__(self):
        '''
        Initial the custom file by self
        '''
        self.encrypt = False

    def hello(self):
        '''
        This is a welcome speech
        :return: self
        '''
        print("*" * 50)
        print(' ' * 15 + 'm3u8链接下载小助手')
        print(' ' * 5 + '作者: autofelix  Date: 2021-06-01 12:42')
        print(' ' * 10 + '适用于非加密 | 加密链接')
        print("*" * 50)
        return self

    def run(self):
        pass

if __name__ == '__main__':
    M3u8().hello().run()