Где найти учебные пособия для scaladoc 2?

Ответ 1

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

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

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

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

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

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

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

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

Ответ 2

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

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

Ответ 3

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

Ответ 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 {@link type#instanceMethod(int, String)} или {@link type.staticMethod()}).

Ответ 5

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