Страницы

Поиск по вопросам

воскресенье, 16 февраля 2020 г.

Исходный код в документации

#java #python #любой_язык #документация #javadoc


Можно ли в Javadoc указывать ссылку на исходный код классов и методов, чтобы не нужно
было каждый раз искать по каталогам нужный файл? Если да, то как это сделать? 

Вот пример для Python: документация SymPy содержит ссылки на исходники классов и методов.

Есть ли вообще какие-либо традиции для разных языков, каким способом публикуется
исходный код? Когда уместно прямо в документации выкладывать исходники, а когда достаточно
ссылки на Github?
    


Ответы

Ответ 1



У javadoc есть опция -linksource, которая включает исходный код в сгенерированную документацию. Например, в документации Guava есть ссылки на исходники в названиях классов и методов. Если код хранится в другом месте, можно использовать простую HTML ссылку .

Комментариев нет:

Отправить комментарий