Синтаксический анализ строки документации Python из JavaScript - PullRequest
0 голосов
/ 17 февраля 2012

Мне нужно проанализировать строку документации из нескольких файлов Python, и мне нужно сделать это с Javascript.

Не могу найти ссылку на это, есть идеи?

РЕДАКТИРОВАТЬ: я работаю с Titanium SDK и jquery. PyDoc - это не решение, которое я ищу, потому что я не хочу включать какой-либо процесс в середину javascript и исходного кода python.

РЕДАКТИРОВАТЬ 2: РЕШЕНО - Titanium может использовать python и javascript одновременно, поэтому я могу использовать python для анализа строки документации из файлов python.

Ответы [ 2 ]

0 голосов
/ 17 февраля 2012

Не существует "жесткого" принудительного формата docstring, но, как и в большинстве Python, только документ "с наилучшей практикой". См. Следующий документ PEP, в котором описывается, как использовать строки документации и чем они являются, а также множество ссылок для последующего чтения: http://www.python.org/dev/peps/pep-0257/

Вы также можете попробовать посмотреть PyDoc , который используется внутри Python для отображения строк документации. Он может выводить HTML, но даже если этого недостаточно, вы сможете перенести Python source в JavaScript, чтобы написать свой собственный анализатор.

0 голосов
/ 17 февраля 2012

Проверьте, как работает лексер SyntaxHighlighter . Это должно дать вам некоторое представление о том, как действовать. Есть и другие синтаксические средства подсветки для изучения, если это не соответствует вашим целям.

...