документация по коду для python [закрыто]
Статья MSDN: Практическое руководство. Проверка того, что строки находятся в допустимом формате электронной почты
Этот метод example вызывает метод Regex.IsMatch (String, String), чтобы убедиться, что строка соответствует шаблону регулярного выражения.
Function IsValidEmailFormat(ByVal s As String) As Boolean
Return Regex.IsMatch(s, "^([0-9a-zA-Z]([-\.\w]*[0-9a-zA-Z])*@([0-9a-zA-Z][-\w]*[0-9a-zA-Z]\.)+[a-zA-Z]{2,9})$")
End Function
5 ответов
Epydoc также является хорошим инструментом для документирования исходного кода и обрабатывает перекрестные ссылки на классы, модули, переменные и т. Д. В HTML, PDF, LaTeX. Рисует также хорошие диаграммы наследования классов. Он используется рядом проектов с открытым исходным кодом, поэтому он довольно активно развивается.
Использование фильтра Doxypy с Doxygen также хорошо
Условные обозначения: PEP 257 и PEP 8 . Обратите внимание, что строки документов могут быть записаны в reStructuredText
Инструменты для создания документации: например Sphinx
Во-первых, добавьте комментарии в ваши строки документов, используя формат RestructuredText.
Во-вторых, получить сфинкс .
В-третьих, создайте индекс, который использует расширение autodoc .
Затем запустите Sphinx, чтобы получить действительно хорошую документацию.
Очень хорошо поместить документацию кода в сам код. См.:
-
1Хорошая, I' ve замеченные другие подходы, такие как изменение владельца/usr/local/Cellar к whoami или Разрешению группам записать на/usr/local – orlybg 29 March 2014 в 05:26