Me emborraché 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?¿Dónde encontrar tutoriales para scaladoc 2?
docs.scala-lang.org es una fuente más reciente de "documentación dirigida por la comunidad para Scala" (gracias a la iniciativa dirigida por Heather Miller).
(editado por Martin Konicek en David James original answer) El Scaladoc page está bastante actualizado.
Martin Konicek pregunta en el comentario cómo hacer un simple Javadoc-like {@link}.
(Y {@link} no se menciona en scala.tools.nsc.ast.DocComments.scala)
Menciona que Scaladoc utiliza [[fullyQualifiedName]] en lugar de {@link}.
respuesta inicial (julio/septiembre 2011)
En este momento, la fuente más completa de información que sé de Scaladoc2 está en la nueva scala-lang.org Wiki.
David James menciona en los comentarios Syntax page, y Tags and Annotations.
El author page tiene ejemplos, incluyendo un what's new section:
Los autores de la documentación ya no tienen que usar etiquetas HTML en sus comentarios.
En cambio, Scaladoc admite una sintaxis similar a la wiki muy similar a la utilizada en Trac.
En general, los autores de Scaladoc ya no deberían usar etiquetas HTML en la documentación, ya que Scaladoc en el futuro también puede generar documentación en otros formatos que no sean HTML.
El Scala Style Guide tiene un nice introductory page on scaladoc. Lo recomendaría sobre el wiki de scala-lang.org mencionado en la respuesta de @VonC.
. Recomendaría este recurso sobre todos los demás también. –
Escribí un Scaladoc HOWTO sobre github here.
Es un procedimiento escrito con Scaladoc en sí, por lo que sirve de ejemplo. Puse un énfasis adicional en cómo hacer que la documentación del paquete aparezca en su API, ya que esto no está muy claro en la documentación oficial.
Muchas gracias, este es un recurso fantástico. –
¡Me di cuenta de que usabas con frecuencia '/ * #! scaladoc */'en tu fuente. ¿Es esto importante? –
No se requiere la notación! # Por Scaladoc. Puede ignorarlo. Está destinado a marcar el tipo de comentario codificado que contiene el archivo. –
A condensada ejemplo completo:
/** 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) = {}
}
Nota que Scaladoc 2,9 no soporta [[enlaces]] a métodos (como Javadoc 's {@link type#instanceMethod(int, String)} o {@link type.staticMethod()}).
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 marcación para su navegador o péguelo en http://markdownlivepreview.com/ para leerlo.
Después de investigar, encontré más contenido en la wiki que mencionaste: [Sintaxis] (https://wiki.scala-lang.org/display/SW/Syntax) y [Etiquetas y anotaciones] (https: //wiki.scala-lang.org/display/SW/Tags+and+Annotations). –
@martin: buen punto. Esa podría ser una pregunta propia. – VonC
@MartinKonicek Tenga en cuenta que https://github.com/scala/scala/blob/master/src/compiler/scala/tools/nsc/ast/DocComments.scala no menciona '@ link'. – VonC