Найти - Пользователи
Полная версия: Как писать доки для API
Начало » Python для новичков » Как писать доки для API
1
asilyator
…, чтобы их показывал eclipse, как для явы?
eprikazc
наверное, нужно 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
>>> def asdf():
... """ hello """
... pass
...
>>> help(asdf)
Help on function asdf in module __main__:

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

В питоне нету определенного формата докстрингов, как в яве (@param, @return) или дотнете?
ziro
asilyator
В питоне нету определенного формата докстрингов, как в яве (@param, @return) или дотнете?
Конечно же есть! ПМСМ лучшее решение для оформления документации на питоне а также ее перевод в читабельный вид - это sphinx - http://sphinx.pocoo.org/
На мой взгляд sphinx даже получше будет средств .net и java благодаря своей дружелюбности и гибкости.
bw
Я использую epydoc.
Хотя не часто вообще этим занимаюсь.

..bw
This is a "lo-fi" version of our main content. To view the full version with more information, formatting and images, please click here.
Powered by DjangoBB