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

234
16 марта 2017, 20:32

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

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

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

Answer 1

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

Например, в документации Guava есть ссылки на исходники в названиях классов и методов.

Если код хранится в другом месте, можно использовать простую HTML ссылку <a href='https://github.com/...'>.

READ ALSO
Spring mvc работа с изображениями

Spring mvc работа с изображениями

Здравствуйте, делаю небольшое веб-приложение на SpringНужна возможность хранить изображения отправленные из формы на сервер

474
NullPointerException SQL

NullPointerException SQL

Выбрасывает исключение javalang

342
Как сложить все элементы массива строк?

Как сложить все элементы массива строк?

Пишу приложение на Android StudioЧерез код по нажатию кнопки добавляются дополнительные поля к посту

319
Как запретить выделять и редактировать TableView

Как запретить выделять и редактировать TableView

Мне необходимо выделить строку в таблице и затем "заблокировать" выделение и редактирование других строк до определенного действияКак это...

342