Flask使用Sphinx生成文档,Sphinx用于#:标记文档属性的注释:
对于模块数据成员和类属性,可以将文档放入具有特殊格式的注释(使用a
#:来启动注释而不是仅仅#),或者在定义之后的docstring中.
此外,来自Flask的风格指南:
如果注释用于记录属性,请在开始井号后面放一个冒号(
#)
如果您没有使用像Sphinx这样理解的文档生成器#:,那么使用#:注释是没有意义的.特别是,Python不会将它们与其他任何注释区别对待.
| 归档时间： |
|
| 查看次数： |
86 次 |
| 最近记录： |