如何为Django方法/类编写注释/文档

Question

我对Django很新，我想知道我是否可以记录我的方法或类。 在C＃中你会有像

这样的东西

 ///
 <summary>
 this is my method xy
 </summary
 public void xy(){
 }

如何在Django中记录或描述方法？ 我见过像

这样的东西

def xy(self):
   """ this is my method xy """

但是当我在我的django代码中使用它时，我收到错误。

编辑：奇怪。在settings.py中取消注释后，不再有错误。 当我使用Aptana3（IDE for python）并开始输入方法 xy 时，我看到描述这是我的方法xy ，这没关系。

但是没有内部Django功能可以将所有记录的类和方法打印到html文件中吗？

我在哪里可以看到文档？只有具有自动完成功能的IDE或django收集我的方法的所有描述并在html中显示它们，放在我的django项目中？

Answer 1

记录Django项目的一个很好的选择是Sphinx。

使用Sphinx，您可以生成多种格式的文档（HTML，PDF，LaTeX等） autodoc extension可以让您轻松记录您的方法和属性。