¿Dónde encontrar tutoriales para scaladoc 2?
(5)
Bingé o busqué en Google para el tutorial o ejemplo de scaladoc 2.0, no pude encontrar nada, de hecho ni siquiera un enlace a la documentación oficial de scaladoc 2.0. ¿Alguien sabe dónde encontrar uno?
Escribí un CÓMO Scaladoc sobre github here .
Es un tutorial escrito con Scaladoc en sí mismo, por lo que sirve de ejemplo. Hice un mayor énfasis en cómo obtener la documentación del paquete para que aparezca en su API, ya que esto no está muy claro en la documentación oficial.
Esta es la mejor guía de Scaladoc que he encontrado: https://gist.github.com/VladUreche/8396624 . Es texto de reducción, así que descárguelo y use un complemento de visor de reducción de calificación para su navegador o péguelo en http://markdownlivepreview.com/ para leerlo.
La Guía de estilo de Scala tiene una buena página de introducción en scaladoc . Lo recomendaría sobre el wiki de scala-lang.org mencionado en la respuesta de @VonC.
Un ejemplo completo condensado:
/** 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) = {}
}
Tenga en cuenta que Scaladoc 2.9 no admite [[enlaces]] a métodos (como {@link type#instanceMethod(int, String)} {@link type.staticMethod()} o {@link type.staticMethod()} ).
docs.scala-lang.org es una fuente más reciente de "documentación impulsada por la comunidad para Scala" (gracias a la iniciativa liderada por Heather Miller ).
(editado por Martin Konicek en la answer original de David James ) La página Scaladoc está bastante actualizada.
Martin Konicek pregunta en el comentario cómo hacer un {@link} similar a {@link} .
(Y {@link} no se menciona en scala.tools.nsc.ast.DocComments.scala )
Menciona que Scaladoc usa [[fullyQualifiedName]] lugar de {@link} .
Respuesta inicial (julio / septiembre 2011)
En este momento, la fuente de información más completa que conozco sobre Scaladoc2 está en el nuevo Wiki de scala-lang.org .
David James menciona en los comentarios la página de Sintaxis y las Etiquetas y Anotaciones .
La página del autor tiene ejemplos, incluyendo una sección de novedades :
Los autores de la documentación ya no tienen que usar etiquetas HTML en sus comentarios.
En su lugar, Scaladoc admite una sintaxis similar a la wiki muy similar a la utilizada en Trac.
En general, los autores de Scaladoc ya no deben usar etiquetas HTML en la documentación, ya que en el futuro Scaladoc también puede generar documentación en otros formatos que no sean HTML.