Categories: Flask 中文教程

Flask 文档注释

文档字符串约定:

所有的文档注释应为 Sphinx 可理解的 reStructuredText 格式,其格式根据注释行数而变化。
如果只有一行,闭合的三引号和开头的三引号在同一行,
否则开头的三引号与文本在同一行,而闭合的三引号另起一行:

def foo():
    """This is a simple docstring"""


def bar():
    """This is a longer docstring with so much information in there
    that it spans three lines.  In this case the closing triple quote
    is on its own line.
    """
模块标头:

模块标头包含一个 utf-8 编码声明(即使没有使用非 ASCII 字符,也始终推荐这么做)
和一个标准的文档注释:

# -*- coding: utf-8 -*-
"""
    package.module
    ~~~~~~~~~~~~~~

    A brief description goes here.

    :copyright: (c) YEAR by AUTHOR.
    :license: LICENSE_NAME, see LICENSE_FILE for more details.
"""

请留意,合适的版权和许可证文件对于 Flask 扩展通过审核是必须的。

admin

这个人很懒,什么都没有留下~

Share
Published by
admin

Recent Posts

vue:页面注入js修改input值

一般会直接这样写: let z…

3 小时 ago

聊聊vue3中的defineProps

在Vue 3中,defineP…

1 周 ago

在 Chrome 中删除、允许和管理 Cookie

您可以选择删除现有 Cooki…

2 周 ago

自定义指令:聊聊vue中的自定义指令应用法则

今天我们来聊聊vue中的自定义…

3 周 ago

聊聊Vue中@click.stop和@click.prevent

一起来学下聊聊Vue中@cli…

4 周 ago

Nginx 基本操作:启动、停止、重启命令。

我们来学习Nginx基础操作:…

1 月 ago