Запитання з тегом «docstring»

Закрито . Це питання ґрунтується на думці . Наразі відповіді не приймаються. Хочете вдосконалити це питання? Оновіть питання, щоб на нього можна було відповісти фактами та цитатами, відредагувавши цю публікацію . Закрито 2 роки тому . Я бачив декілька різних стилів написання доктрингів у Python, чи існує офіційний чи «узгоджений» …

887 python  coding-style  documentation  docstring 

Закрито . Це питання ґрунтується на думці . Наразі відповіді не приймаються. Хочете вдосконалити це питання? Оновіть питання, щоб на нього можна було відповісти фактами та цитатами, відредагувавши цю публікацію . Закрито 2 роки тому . Удосконаліть це питання В даний час я починаю з Python, і у мене є …

162 python  documentation  javadoc  docstring 

Закрито . Це питання ґрунтується на думці . Наразі відповіді не приймаються. Хочете вдосконалити це питання? Оновіть питання, щоб на нього можна було відповісти фактами та цитатами, відредагувавши цю публікацію . Закрито 2 роки тому . Удосконаліть це питання Я пишу легкий клас, атрибути якого призначені для загальнодоступного доступу, і …

115 python  class  documentation  docstring  class-attributes 

Закрито . Це питання має бути більш сфокусованим . Наразі відповіді не приймаються. Хочете покращити це питання? Оновіть питання, щоб воно зосереджувалось на одній проблемі, лише відредагувавши цю публікацію . Закрито 2 роки тому . Удосконалюйте це питання Мені подобається Doxygen створювати документацію коду C або PHP. У мене є …

94 python  documentation  doxygen  docstring  python-sphinx 

Чи можна легко додати рядок документації до іменованого парню просто? я намагався from collections import namedtuple Point = namedtuple("Point", ["x", "y"]) """ A point in 2D space """ # Yet another test """ A(nother) point in 2D space """ Point2 = namedtuple("Point2", ["x", "y"]) print Point.__doc__ # -> "Point(x, y)" …

85 python  docstring  namedtuple 

У мене є скрипт Python з текстовою документацією. Коли аналіз аргументів командного рядка не вдається, я хочу надрукувати рядок документації для інформації користувача. Чи є спосіб зробити це? Мінімальний приклад #!/usr/bin/env python """ Usage: script.py This describes the script. """ import sys if len(sys.argv) < 2: print("<here comes the docstring>")

79 python  docstring 

Чи підтримує PyCharm 2.7 (чи PyCharm 3) підтримує власні таблиці та док-тести? Якщо так, то як можна писати цей конкретний тип спеціального розширення? Мій поточний проект стандартизував використання Посібника зі стилів Google Python ( http://google-styleguide.googlecode.com/svn/trunk/pyguide.html ). Мені подобається підтримка документації PyCharm, але зараз це лише два підтримувані формати - epytext …

75 python  pycharm  docstring  doctest  sphinx-napoleon