Documentation文档化(转)

用于创建erlang文档的方法。

edoc:application/2: Creates documentation for a typical Erlang application.

edoc:packages/2: Creates documentation for one or more packages, automatically locating source files.

edoc:files/2: Creates documentation for a specified set of source files.

edoc:run/3: General interface function; the common back-end for the above functions. Options are documented here.

Module tag （模块注解标记）

@author

@copyright

@doc   (description of the module)

@referenct (give further information, can include XHTML format). "<a href="http://.../"> abcd </a>"

@version

@since (when this module introduced in the system)

@hidden or @private

@title

@see 

Function tag （方法注解标记）

@spec (give the type of function, same as the -spec)

@doc (general document for a function, can use the XHTML markup)

@throws

@deprecated

@hidden

@private

@since

Generic tag （一般通常标记）

@type (give a definition of type, same as -type)

@todo (not appear in the document, unless the todo option is actives)

转自： http://blog.sina.com.cn/s/blog_453a02280100qpl7.html