Как использовать @See scaladoc?

Question

Каков точный синтаксис использования @See scaladoc?Как мне сослаться:

• метод в том же классе
• другой класс
• ссылка "http"

?

Answer 1

Синтаксис такой же, как и в любой другой части скалярного документа.Вы в основном добавляете нотацию @see, а затем пишете чистый текст, описывающий ссылку.Примеры:

• @see [[method]]
• @see [[YourCurrentClass.method]]
• @see [[YourCurrentClass]]
• @see See [[scala.concurrent.Future]] for more
• @see See [[http://example.com the full documentation]] on possible values of ABC

РЕДАКТИРОВАТЬ:

официальная документация на @see: https://docs.scala -lang.org / Overviews / scaladoc / for-library-автор.html # использовании-теги

официальная документация по ссылкам в целом: https://docs.scala -lang.org / Overviews / scaladoc / for-library-автор.html # markup