Updated 用reStructuredText语法为代码写注释 (markdown)

master
lyhuang18 6 years ago
parent
commit
635e0eeb56
1 changed files with 1 additions and 2 deletions
  1. +1
    -2
      用reStructuredText语法为代码写注释.md

+ 1
- 2
用reStructuredText语法为代码写注释.md

@@ -30,8 +30,7 @@ def my_function(my_arg, my_other_arg):
``` ```
### Tips: ### Tips:
1. 在`:param arg:`前必须空一行,才能显示出参数和返回值列表;在`arg`前面可以加上变量类型 1. 在`:param arg:`前必须空一行,才能显示出参数和返回值列表;在`arg`前面可以加上变量类型
2. `::`标记如果作为独立段落存在,则整段都不会出现在文档里;如果前面有空白,则标记被移除;如果前面是非空白,则标记被一个冒号取代。
3. `.. note::`能生成一个note
2. `.. note::`能生成一个note




## 其他可能会用到的 ## 其他可能会用到的


Loading…
Cancel
Save