diff --git a/用reStructuredText语法为代码写注释.md b/用reStructuredText语法为代码写注释.md index 7442540..119700f 100644 --- a/用reStructuredText语法为代码写注释.md +++ b/用reStructuredText语法为代码写注释.md @@ -29,7 +29,7 @@ def my_function(my_arg, my_other_arg): """ ``` ### Tips: -1. 在`:param arg:`前必须空一行,才能显示出参数和返回值列表;在arg前面可以加上变量类型 +1. 在`:param arg:`前必须空一行,才能显示出参数和返回值列表;在`arg`前面可以加上变量类型 2. `::`标记如果作为独立段落存在,则整段都不会出现在文档里;如果前面有空白,则标记被移除;如果前面是非空白,则标记被一个冒号取代。 3. `.. note::`能生成一个note