Где найти учебники для scaladoc 2?

Question

Я выискивал или гуглил учебник или пример по scaladoc 2.0, я ничего не мог найти, на самом деле даже не ссылка на официальную документацию по scaladoc 2.0.Кто-нибудь знает, где его найти?

Answer 1

docs.scala-lang.org - более поздний источник "документации сообщества для Scala" (благодаря инициативе Хизер Миллер ).
(отредактировано Мартином Коничеком в Оригинал Дэвида Джеймса ответ ) Страница Scaladoc довольно актуальна.

Мартин Коничек спрашивает в комментарии, как сделать простой Javadoc-подобный {@link}.
(А {@link} не упоминается в scala.tools.nsc.ast.DocComments.scala)

Он упоминает, что Скаладок использует [[fullyQualifiedName]] вместо {@link}.

---

Первоначальный ответ (июль / сентябрь 2011 г.)

Сейчас большинствоПолный источник информации, которую я знаю о Scaladoc2, находится в новых scala-lang.org Wiki .

Дэвид Джеймс упоминает в комментариях Синтаксическая страница и Теги и аннотации .

На странице автора есть примеры, в том числе что нового раздела :

Авторам документации больше не нужно использовать теги HTML в своих комментариях.
Вместо этого Scaladoc поддерживает вики-подобный синтаксис , очень похожий на используемый в Trac.
В целомАвторы Scaladoc больше не должны использовать теги HTML в документации, поскольку в будущем Scaladoc может также создавать документацию в других форматах, отличных от HTML.

Answer 2

Я написал Scaladoc HOWTO на github здесь .

Это руководство, написанное для самого Scaladoc, поэтому оно служит примером.Я особо подчеркнул, как сделать так, чтобы документация пакета отображалась в вашем API, поскольку в официальной документации это не очень понятно.

Answer 3

Scala Style Guide имеет красивую вводную страницу по scaladoc .Я бы порекомендовал это по вики scala-lang.org, упомянутой в ответе @ VonC.

Answer 4

Сокращенный полный пример:

/** Creates [[mypackage.Person]] instances, taking a `String` argument. */
object Person {
  /** Create a [[mypackage.Person]] with a given name.
  *
  * This is another paragraph (note the empty line above) containing '''bold''',
  * ''italic'', `monospace`, __underline__, ^superscript^, and ,,subscript,,.
  * 
  * Example:
  * {{{
  * val person = Person("Bill")
  * }}}
  *
  * @param name their name
  * @return a new Person instance
  */
  def apply(name: String) = {}
}

Обратите внимание, что Scaladoc 2.9 не поддерживает [[ссылки]] для методов (например, Javadoc 's {@link type#instanceMethod(int, String)} или {@link type.staticMethod()}).

Answer 5

Это лучшее руководство по Scaladoc, которое я нашел: https://gist.github.com/VladUreche/8396624. Это текст уценки, поэтому скачайте его и используйте плагин для просмотра уценок для вашего браузера или вставьте его в http://markdownlivepreview.com/, чтобы прочитать его.