Python-сообщество

asilyator · Окт. 30, 2010 13:59:23

…, чтобы их показывал eclipse, как для явы?

Отредактировано (Окт. 30, 2010 13:59:45)

eprikazc · Ноя. 1, 2010 09:26:50

наверное, нужно doc-стринги писать:

def complex(real=0.0, imag=0.0):
    """Form a complex number.

    Keyword arguments:
    real -- the real part (default 0.0)
    imag -- the imaginary part (default 0.0)

    """

http://www.python.org/dev/peps/pep-0257/#multi-line-docstrings

asilyator · Ноя. 2, 2010 13:36:29

>>> def asdf():
...     """ hello """
...     pass
...
>>> help(asdf)
Help on function asdf in module __main__:

asdf()
    hello

Работает что с “”", что с ‘'’. Но эклипс вместо доков показывает начало исходника, при этом из стандартных библиотек он все показывает. Глюк эклипса?

В питоне нету определенного формата докстрингов, как в яве (@param, @return) или дотнете?

ziro · Ноя. 2, 2010 18:52:43

asilyator
В питоне нету определенного формата докстрингов, как в яве (@param, @return) или дотнете?

Конечно же есть! ПМСМ лучшее решение для оформления документации на питоне а также ее перевод в читабельный вид - это sphinx - http://sphinx.pocoo.org/
На мой взгляд sphinx даже получше будет средств .net и java благодаря своей дружелюбности и гибкости.

bw · Ноя. 2, 2010 20:33:43

Я использую epydoc.
Хотя не часто вообще этим занимаюсь.

..bw

Python-сообщество

Уведомления

#1 Окт. 30, 2010 13:59:23

Как писать доки для API

#2 Ноя. 1, 2010 09:26:50

Как писать доки для API

#3 Ноя. 2, 2010 13:36:29

Как писать доки для API

#4 Ноя. 2, 2010 18:52:43

Как писать доки для API

#5 Ноя. 2, 2010 20:33:43

Как писать доки для API

Board footer