<分区>
我刚刚用 Django 开始了一个项目，我想为 Python 函数编写类似下面的 javadoc 片段的内容。我已经看到我可以使用 Sphinx 或 reStructuredText 但它似乎有点过分了。在 Python 中执行此操作的常规方法是什么？
我的目标不是用我的文档生成一个大的 pdf/html，而是让我的 IDE (pyCharm) 在我调用我的方法时显示文档。
/**
*
* @param p1
* @param p2
* @param p3
* @return ...
*/
最佳答案
我在 Django 和纯 Python 项目中广泛使用 IntellJ IDEA/PyCharm。
方法肯定是 reStructuredText 和 Sphinx，后者只有在您想要生成 HTML 或 PDF 文档时才使用。这也是 Python 库本身的记录方式。几个月前，我从 epydoc 切换到 reStructuredText，因为后者的一般支持要好得多。
您的文档字符串将如下所示:
def myfunc(p1, p2, p3):
"""myfunc does something interesting.
some more detail. See :meth:`my_other_func` for more information.
:param p1: The first parameter.
:type p1: string
:param p2: The second parameter.
:param p3: The third parameter.
:returns: True if successful, False if not.
"""
my_code(p1)
more_code(p2)
return third_part(p1,p2,p3)
它与基本元素的旧 epydoc 标准没有太大区别。 PyCharm 能够解析此信息，例如使用 :type: specs 在您的函数主体中完成。
关于python - 记录我的 Django 代码，我们在Stack Overflow上找到一个类似的问题： https://stackoverflow.com/questions/16978954/
相关文章：
python - 在 windows 和 python 2.6.1 下使用 Cheetah 模板系统(namemapper 问题)
python - 对 GTK (Python) 中 WebKit WebView 实现的 API 引用
documentation - 有没有翻译 Markdown 格式文本的方法？
python 子进程在 systemctl 启动时找不到 shell 命令
python - "How to fix: ' 只有整数、切片( `:` )、省略号( `...` )、numpy.newaxis ( `None` ) 和整数或 bool 数组是有效索引'？
python - 如何从 django templatetag 访问 python 列表？