1

Есть ли какой-нибудь инструмент (желательно на Python), который позволяет создавать отчеты в HTML, Markdown или reStructuredText из произвольного исходного кода (Python, R, Javascript и т. Д.)?Сгенерировать HTML-отчеты из исходного кода

Ближайшая вещь, которую я нашел до сих пор, это pyreport, которая поддерживает только python. Идея состоит в том, чтобы иметь возможность получить быстрый отчет из хорошо документированного исходного кода. Это отличается от грамотного программирования; здесь я хочу что-то похожее на следующее:

file.py

# ```*This is part of a comment* 
# maybe some equations $c^2=a^2+b^2$ or [links](http://mylink.com) here ``` 
def calculate_something(): 
    print(42) 
calculate_something() 

и доклад должен быть чем-то вроде этого:

Это часть комментария

возможно, некоторые уравнения $ c^2 = a^2 + b^2 $ или links здесь

42 

Это очень похоже на инструменты генератора документации, но мне нужно, чтобы они работали на разных языках, а большинство (если не все) являются языковыми.

+1

Downvoter, пожалуйста, скажите мне, что случилось с этим вопросом. В противном случае я не могу его улучшить. –

+0

Один вопрос: шляпа '42' в ожидаемом выходе, подразумевает, что, помимо извлечения комментариев, код должен быть запущен? Я не могу придумать какой-либо инструмент, который сделает это, потому что код может быть модулем или программой, ожидающей ввода данных. Можете ли вы пояснить, что инструмент должен использовать в качестве входных данных (file.py?) И как это сделать вы ожидаете, что инструмент будет чередовать комментарии с помощью исполняемого кода? – jjmontes

+0

Спасибо. В идеале инструмент сможет извлечь код, который должен быть запущен, но пользователь должен предоставить способ его запуска. Да, инструмент будет использовать 'file.py' (в приведенном выше примере) в качестве ввода. Я не уверен, что понимаю ваш последний вопрос. Вы имеете в виду, как должен работать инструмент для подготовки окончательного отчета? Кстати, я думаю, что есть некоторые сценарии, в которых такой инструмент не был бы настолько полезен (например, когда ваш код не может быть описан последовательно с использованием его комментариев) –

ответ

1

Возможно, вы используете один из инструментов, перечисленных в документации на Python Wiki для исходного кода, которая обычно извлекает структуру из вашего кода и включает ваши документы в документации.

https://wiki.python.org/moin/DocumentationTools

+0

Спасибо. Doxygen выглядит многообещающим. –

+0

Я использую Doxygen для нашего кода на C#, а затем JSDoc для нашего кода AngularJS. PHPDocumenter, также используемый для веб-сайтов PHP. –