en proyectos de código abierto que veo las siguientes dos maneras de especificaciones técnicas de escritura:guía para escribir especificaciones en Erlang
especificaciones en los comentarios
@spec start_link() -> {ok, pid()}
Especificaciones de código fuente
-spec start_link() -> {ok, pid()}
¿Cuál es la ¿diferencia? ¿Se prefiere uno sobre el otro?
La versión de comentario (@spec) es anterior a la versión del código fuente (-spec). Este último es preferible.
acuerdo con EDoc documentation:
Nota: Aunque la sintaxis descrita en el siguiente todavía se puede utilizar para especificar las funciones, se recomienda que las especificaciones de Erlang como descritos en Types and Function Specification deben añadirse al código fuente vez . De esta forma, los análisis de Dialyzer pueden ser utilizados en el proceso de mantener la documentación consistente y actualizados. Las especificaciones de Erlang se usarán a menos que también haya una especificación de función (una etiqueta @spec seguida de un tipo) con el mismo nombre .