Documentation文档化(转)
来源:互联网 发布:ospf端口号 编辑:程序博客网 时间:2024/05/21 14:42
用于创建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
阅读全文
0 0
- Documentation文档化(转)
- OpenCV documentation 官方文档
- Linux内核文档翻译:Documentation/gpio.txt(转+改)
- libevent 文档 (libevent Documentation)
- im4java学习---阅读documentation文档
- Python pencv documentation文档教程
- NHibernate Reference Documentation - NHibernate 参考文档
- NHibernate Reference Documentation - NHibernate 参考文档
- Python 3 文档(简体中文) 3.2.2 documentation
- Documentation下ARM中的Booting文档翻译
- Documentation目录下binfmt_misc文档的翻译
- Xcode 文档安装-iOS 8.1 Documentation
- 官方文档Python 2.7.11 documentation
- opencv文档——opencv documentation网址
- Linux内核文档翻译:Documentation/arm/Booting
- Documentation
- Documentation
- JDK 6 Documentation - JDK 5 Documentation v6.0, Java 2 SDK 英文文档
- Python中switch-case实现(转)
- iconv字符编码转换全攻略(转)
- ubuntu 12.04中没有javac编译器的解决办法(转)
- eclipse调试web项目的第三方jar
- ubuntu 12.04搭建Erlang开发环境
- Documentation文档化(转)
- ubuntu配置
- MPEG的帧Frame(转)
- Maven(一)约定的目录结构、常用命令
- GS库用户指南(基本API篇)(转)
- mac os 安装 boost库(转)
- [Java]多线程/继承Thead类/实现runnable接口
- Unity脚本的生命周期
- Apple Swift编程语言入门教程(转)