TinyOS编码与佳实践指南.pdfVIP

CodingStandard

TEP:3

Group:TinyOS2.0WorkingGroup

Type:BestCurrentPractice

Status:Draft

TinyOS-Version:2.x

Author:IonYannopoulos,David

Draft-Created:31-Dec-2004

Draft-Version:1.5

Draft-Modified:2006-12-12

Draft-Discuss:TinyOSDeveloperListtinyos-develat

mail.millennium.berkeley.edu

Note

ThisdocumentspecifiesaBestCurrentPracticesfortheTinyOSCommunity,andrequestsdis-

cussionandsuggestionsforimprovements.Distributionofthismemoisunlimited.Thismemois

infullcompliancewith[TEP1].

Contents

1Introduction

2GeneralConventions

2.1General

3Packages

3.1Directorystructure

4LanguageConventions

4.1nesCconvention

4.1.1Names

4.1.2Packages

4.1.3Preprocessor

4.2CConvention

4.3Javaconvention

4.4Otherlanguages

5TinyOSConventions

5.1Errorreturns

5.2在组件之间传递指针5.3布线注释的使

用

6

1引言

Th命名约定的目的有两点：•避免编译或导致错误的。在TinyOS中，避免此类最重要

的地方是在接口和组件名称中。

•使代码的读者能够识别哪些名称是分组在一起的，以及它们是在哪个包中定义的。

请记住，有用的代码最终被阅读的频率将远远高于被编写的频率。如果您偏离了以下建议或要求，

请保持偏离方式的一致性。如果您在代码中添加了任何新的约定，请在README中注明。

2通用约定

2.1一般规范

•避免使用不为人熟知的缩写和缩略语。不要仅仅“因为可以”就进行缩写。

•缩写词应首字母大写（如Java中的Adc），即使用Adc，而不是ADC。例外：两个字母

的缩写应全部大写（例如，用AM表示activemessages，而不是Am）

•如果需要缩写一个单词，请保持一致性。尽量与你自己的代码之外的代码保持一致。

•所有代码都应使用nesdoc[nesdoc],Doxygen[Doxygen]或Javadoc[Javadoc]进行文档

化。理想情况下，每个命令、和函数都应有文档说明。至少每个接口、组件、类或

文件都需要有一段描述。

•如果你为某个文件编写代码，请在顶级文档块中添加一个@author。

3包

在本文档中，包是指以任意所需语言编写的相关源文件和其他文件的集合。包是一种逻辑分组，它可

能但不一定对应于诸如单个目录这样的分组。在TinyOS中，包通常是一个包含零个或多个子目