第16篇 生成程序文档和组件关系结构图

记录一下各文件的位置：

默认情况下：

系统中所有的应用程序都放在 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.

*

**/