Python 注释详解

1 概述

1. 养成良好的的 '编码习惯'

2. 保持代码的 '可读性' 和 '可维护性'

2 分类

2.1 普通注释

# 单行注释，不生成文档

2.2 文档注释 docstring

"""
  多行注释 1，可生成文档
  '回车' 换行，自动提示 '参数' 与 '返回值'
"""

'''
  多行注释 2，与上同理
'''

2.3 文件注释

常用设置：（File -> Settings -> File and Code Templates - Python Script）

# !/usr/bin/env python3
# -*- coding: utf-8 -*-
# @Project: ${PROJECT_NAME}
# @File   : ${NAME}
# @Time   : ${DATE} ${TIME}
# @Author : ${USER}

New -> Python Script 效果：

# !/usr/bin/env python3
# -*- coding: utf-8 -*-
# @Project: flaskDemo
# @File   : Test03
# @Time   : 2021/4/27 10:19
# @Author : YoYo

3 生成文档注释 pydoc

1. 命令终端切换至当前目录下，如:
   d:
   cd D:/08 Codeing/flaskDemo/demo

2. 执行命令
   python -m pydoc -w 当前目录名称
   python -m pydoc -w AnnotationDemo
   
3. 生成 html 文件（当前目录下）
   wrote AnnotationDemo.html

文件路径：

文件内容：

class ClassDemo:
    """
    测试类
    """

    def say(self, hello):
        """
        说句话
        :param hello: 文本
        :return:  返回值
        """
        print(hello)


if __name__ == '__main__':
    # 打印 文档注释
    print(help(ClassDemo))