как писать комментарии / документацию для методов / классов Django - PullRequest
0 голосов
/ 09 февраля 2012

Я совсем новичок в 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 для python) и начинаю набирать в методе xy , я вижу описание , это мой метод xy , и это нормально.

Но этонет ли в Django функции для печати всех этих документированных классов и методов в html-файл?

А где я могу найти документацию?Только IDE с автозаполнением или django собирает все описания моих методов и показывает их в html, размещенном в моем проекте django?

1 Ответ

2 голосов
/ 09 февраля 2012

Хороший выбор для документирования вашего проекта Django: Sphinx .

С помощью Sphinx вы можете создавать документы в нескольких форматах (HTML, PDF, LaTeX и т. Д.) а расширение autodoc позволяет легко документировать ваши методы и атрибуты.

Добро пожаловать на сайт PullRequest, где вы можете задавать вопросы и получать ответы от других членов сообщества.
...