python适用于streamlit程序的函数注释提取程序（自制）

一、使用需求。

        本程序面向使用标准格式书写函数声明和注释的程序，将其按照一般注释提取工具正常展示页面展示到浏览器。

        因为我自己在对程序进行注释提取的时候发现：注释提取工具诸如pydoc，sphinx，都会默认将程序运行一遍，然后才能得到注释提取结果。然而，我写的streamlit程序并不能直接运行（否则会报错），而是要调用命令行才能运行，因此注释提取一直失败。由此我萌发了写一个不会默认运行程序的注释提取工具的想法。

二、使用说明。

        需要引入的库：streamlit（运行引入streamlit的库的程序要调用浏览器展示，因此要对该程序使用命令行调用，浏览器进行本地展示注释提取结果。之后会展示详细过程）。

        需要修改的参数：程序中注释提取的对象——目标python文件的路径。

        目前实现的功能：对函数的声明及下用三个单引号或者三个双引号括起来的注释提取到一起。并分别展示。

        能够被识别的注释格式：（例如：）

        

单引号，双引号都无所谓，但是要是三个引号引起的注释且写在函数声明正下方，否则视为没有写注释。

即使没有写注释也无所谓，会在注释提取的网页结果中呈现出来。

测试时我注释采用的是pycharm的默认格式（其他格式也行的），展示时会将冒号转为换行。

三、程序代码。（方面后面将步骤）

# coding=gbk

#一个程序注释提取工具，并将其展示为网页形式
# 2024-06-13
# Chen Jing

"""
    提取逻辑如下：
    初始为状态0，即正常状态。
    1.如果获取到以def开头的行，进入函数定义提取状态，即状态“GET_FUNC”，状态1。
    此时会继续遍历，并存储这个过程中从‘(’符号开始到‘):’符号结束的全部内容，每行剔除全部前后空格。
    然后将获取到的内容内含的全部'\n'符号剔除。
    2.如果获取到使用三个双号或三个单引号开头的行，进入提取注释阶段，即状态“GET_COMMENT”。
    此时会继续遍历，并存储这个过程中从‘三个单引号’符号开始到‘三个双引号’符号结束的全部内容，每行剔除全部前后空格。
    然后将获取到的内容内含的全部'\n'符号剔除。
"""

# 需修改的参数（需进行注释提取的文件路径）！！！！！！！！！！！！！！！！！！！！！！！！！！！！
filename= r'..\三阶段-整合\2024.03.25建框架.py'

# 需导入的库，以及运行时采用：在命令行，先定位到程序所在位置，然后键入‘streamlit run + 文件名’（引号不用加）的方式运行！！！
import streamlit as st

# 页面宽度拓宽
st.set_page_con