docstring- все статьи тега
Использование javadoc для документации Python [закрыто]
в настоящее время я начинаю с Python, и у меня есть сильный фон PHP, и в PHP я взял привычку использовать javadoc в качестве шаблона документация. мне было интересно, если javadoc место docstring документация на Python. Является ли что-то подобное слишком сложным, чтобы вписаться в мышление Python, или я должен стараться быть как можно более кратким? """ replaces template place holder with values @param string timestamp formatted date to display @param string priority priority number ...
Как документировать код Python с помощью doxygen [закрыто]
Мне нравится doxygen для создания документации C или PHP кода. У меня есть предстоящий проект Python, и я думаю, что помню, что Python не имеет /* .. */ комментарии, а также будет иметь собственную документацию объекта, который, кажется, быть подходящие для Python путь к документу. поскольку я знаком с doxygen, как я могу использовать его для создания моей документации Python? Есть ли что-то особенное, что мне нужно знать? ...
Добавление docstrings в namedtuples?
можно ли легко добавить строку документации в namedtuple? пробовал 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)" print Point2.__doc__ # -> "Point2(x, y)" но это не имеет значения. Можно ли это сделать каким-то другим способом? ...
Пользовательские заглушки PyCharm docstring (т. е. для форматов Google docstring или numpydoc)
имеет ли PyCharm 2.7 (или PyCharm 3) поддержку пользовательских заглушек docstring и doctest? Если да, то как можно написать этот конкретный тип пользовательского расширения? мой текущий проект стандартизирован с использованием руководства по стилю Google Python (http://google-styleguide.googlecode.com/svn/trunk/pyguide.html). Мне нравится поддержка docstring PyCharm, но сейчас поддерживаются только два формата: epytext и reStructureText. Я хочу, и я готов напишите себе, плагин PyCharm, котор ...