Djangoのメソッド/クラスのコメント/ドキュメントの書き方

Question

私はDjangoでかなり新しく、メソッドやクラスを文書化できるかどうか疑問に思っていました。 C＃ので あなたは私が文書またはジャンゴのメソッドを記述するにはどうすればよい

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

のように気にいらを持っているでしょうか？ 私は

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

のようなものを見てきましたが、私は私のDjangoのコードでこれを使用するとき、私はエラーを取得します。

EDIT： Strange。 settings.pyでいくつかのコメントを外した後、エラーはなくなります。 私はAptana3（PythonのIDE）を使用し、メソッドの入力を開始するxy私は説明を参照してくださいこれは私のメソッドxyであり、それはokです。

しかし、文書化されたすべてのクラスとメソッドをhtmlファイルに出力するためのインターンジャンゴ機能はありませんか？

ドキュメントはどこにありますか？オートコンプリートを持つIDEまたはdjangoは自分のメソッドのすべての記述を収集し、htmlで表示し、私のdjangoプロジェクト内に配置しますか？

Answer 1

Djangoプロジェクトの文書化には、Sphinxが最適です。

スフィンクスでは、複数のフォーマット（HTML、PDF、LaTeXなど）でドキュメントを生成できます。 とautodoc extensionを使用すると、メソッドと属性を簡単に文書化できます。