From 635e0eeb56959c4c12434a3749efa2b0bb50bb29 Mon Sep 17 00:00:00 2001 From: lyhuang18 <42239874+lyhuang18@users.noreply.github.com> Date: Sun, 9 Sep 2018 13:20:09 +0800 Subject: [PATCH] =?UTF-8?q?Updated=20=E7=94=A8reStructuredText=E8=AF=AD?= =?UTF-8?q?=E6=B3=95=E4=B8=BA=E4=BB=A3=E7=A0=81=E5=86=99=E6=B3=A8=E9=87=8A?= =?UTF-8?q?=20(markdown)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- 用reStructuredText语法为代码写注释.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/用reStructuredText语法为代码写注释.md b/用reStructuredText语法为代码写注释.md index 119700f..6282185 100644 --- a/用reStructuredText语法为代码写注释.md +++ b/用reStructuredText语法为代码写注释.md @@ -30,8 +30,7 @@ def my_function(my_arg, my_other_arg): ``` ### Tips: 1. 在`:param arg:`前必须空一行,才能显示出参数和返回值列表;在`arg`前面可以加上变量类型 -2. `::`标记如果作为独立段落存在,则整段都不会出现在文档里;如果前面有空白,则标记被移除;如果前面是非空白,则标记被一个冒号取代。 -3. `.. note::`能生成一个note +2. `.. note::`能生成一个note ## 其他可能会用到的