第16篇 生成程序文档和组件关系结构图
2011-05-03 23:25
148 查看
记录一下各文件的位置:
默认情况下:
系统中所有的应用程序都放在 opt/tinyos-1.x/apps下
系统中所有的系统组件都放在 opt/tinyos-1.x/tos/system下
系统中所有的接口都放在 opt/tinyos-1.x/tos/interface下
通过命令make {platform} docs可以在 opt/tinyos-1.x/doc/nescdoc/{platform}生成source tree和组件关系图。如make pc docs,生成的doc在/opt/tinyos-1.x/doc/nescdoc/pc目录下。通过看结构图来了解程序比较直观。另外,在编写程序的时候, 有一个问题,就是调试程序很困难。因此在编写完程序并且编译通过之后,可以先生成它的结构图,检查是否正确,作为调试程序的一个步骤。结构图一目了然,看起来很舒服。也有助于你自己了解和理解程序。
nesC也可以生成和Java一样的doc,注释为/** **/
@param paramname text text text 描述函数的参数
@return text text text 描述函数的返回值
@author text text text 列出程序的作者
@modified text text text 列出程序的修改
如
/**
* One-line component description.
*
* More text goes here, to give more details to the description.
*
* @author Alice
* @author Bob
* @modified 3/3/2003 Added meaningful documentation.
*
**/
默认情况下:
系统中所有的应用程序都放在 opt/tinyos-1.x/apps下
系统中所有的系统组件都放在 opt/tinyos-1.x/tos/system下
系统中所有的接口都放在 opt/tinyos-1.x/tos/interface下
通过命令make {platform} docs可以在 opt/tinyos-1.x/doc/nescdoc/{platform}生成source tree和组件关系图。如make pc docs,生成的doc在/opt/tinyos-1.x/doc/nescdoc/pc目录下。通过看结构图来了解程序比较直观。另外,在编写程序的时候, 有一个问题,就是调试程序很困难。因此在编写完程序并且编译通过之后,可以先生成它的结构图,检查是否正确,作为调试程序的一个步骤。结构图一目了然,看起来很舒服。也有助于你自己了解和理解程序。
nesC也可以生成和Java一样的doc,注释为/** **/
@param paramname text text text 描述函数的参数
@return text text text 描述函数的返回值
@author text text text 列出程序的作者
@modified text text text 列出程序的修改
如
/**
* One-line component description.
*
* More text goes here, to give more details to the description.
*
* @author Alice
* @author Bob
* @modified 3/3/2003 Added meaningful documentation.
*
**/
相关文章推荐
- 小程序原理,生成SQL SERVER 2008 数据库所有表的结构文档
- 程序文档,框架结构自动生成工具
- 小程序原理,生成SQL SERVER 2008 数据库所有表的结构文档
- 【开源】AspnetCore 2.0 自动API文档生成组件,支持protobuffer
- 正规军的脚步:自动生成你的程序开发文档
- windows生成目录结构输出到txt文档
- 支持多个文档类型的文档视结构程序
- 利用DBExportDoc V1.0 For MySQL自动生成数据库表结构文档
- 第100篇博文纪念 | C# 根据数据库表结构生成DOC数据库文档
- 标准功能模块组件 -- “文档管理组件,网络文档管理,网络存储”,B/S版本组件可独立运行,也可集成到其他项目里,数据结构清晰思路严谨
- MFC让文档/视图结构程序支持滚动条
- 【认识aspx】页面处理程序【页面生成关系】【页面继承关系】
- 使用JavaDoc生成Java程序的使用文档
- 用MongoDB的文档结构描述数据关系
- 【认识aspx】页面处理程序【页面生成关系】【页面继承关系】
- 使用Doxygen软件将程序代码自动生成chm格式帮助文档
- 使用doxygen为C/C++程序生成中文文档
- MongoDB学习笔记(四) 用MongoDB的文档结构描述数据关系
- 【原创分享】django-m2doc, 自动根据project下的所有models生成数据表结构文档.
- 使用doxygen为C/C++程序生成中文文档