首页
学习
活动
专区
工具
TVP
发布
您找到你想要的搜索结果了吗?
是的
没有找到

ReStructuredText 文档编写全攻略编写文档说明

编写文档说明 学 python 的人一定会注意到很多python 文档都很相似,不管是整体风格还是结构组织方式都很类似。...比如: scrapy 文档 scrapy.png 再比如: flask 文档 flask.png 再再比如: reStructuredText 中文文档 rst.png 再再再比如: Python-web-guide...文档即代码:即把文档的编写和 git 代码托管相一致 方便的组织结构:利用工具能很好的组织文档的结构 风格统一:风格不统一,最后项目维护起来存在巨大的沟通成本 这种文档的组织方式核心是使用了 reStructuredText...标记语言编写文档。...采用的是 markdown 编写文档,格式不同,但组织方式和 rst 文档的组织方式很相似,可以对比着感受下,选择适合的方式编写文档 编写文档的整体流程 rst 只是一种标记语言,需要使用恰当的工具,

5.2K31

【Python】函数 ⑤ ( 函数说明文档 | 函数说明文档内容建议 | 代码示例 )

一、函数说明文档 1、函数说明文档简介 函数说明文档 就是 通过 注释 对 函数的作用进行解释说明 ; 函数说明文档 用法 : 在 函数定义 后 , 函数体的第一行位置 , 输入六个双引号 , 此时光标会自动停留在第三个双引号之后..., 在 光标停留在 第三个 双引号 之后 闪烁的状态下 , 敲击回车键 , 会自动生成如下 函数说明文档 的注释格式 , 其中包括 :param 形参: 参数说明格式 , :return: 返回值说明格式...; 注意 : 函数的解释文字 , 要与 第一个形参说明所在行 , 两行之间间隔 1 行 ; 2、函数说明文档内容建议 Python 函数说明文档 建议包含如下内容 : 函数功能描述 : 对函数的功能...代码示例 : """ 函数说明文档 代码示例 """ def add(a, b): """ 函数作用 :param a: 参数一形参说明 :param b: 参数二形参说明...:return: 返回值说明 """ return a + b sum = add(1, 2) 此时 , 如果将鼠标放在 add 函数上 , 在弹出的提示框中 , 会显示 函数说明文档

17210

扫码

添加站长 进交流群

领取专属 10元无门槛券

手把手带您无忧上云

扫码加入开发者社群

相关资讯

热门标签

活动推荐

    运营活动

    活动名称
    广告关闭
    领券