南京嵌入式培训:嵌入式软件注释的技巧

时间:2015-09-09  来源:技术文章  作者:南京达内

  在软件开发过程中,难免会遇到很少或者是没有说明文档的代码库,而这些文档代码的存在是高告诉工程师某个函数或变量存在的意义,这样就需要专业的人员来注释代码,这样的工作对于嵌入式工程师在开发过程中是非常的中,所以对于代码注释人员就需要很高的要求。下面达内南京嵌入式培训就教大家一些注释嵌入式软件的技巧,详细掌握之后有助于帮助开发人员更好的维护代码开发中的变动。
  
  一、自动生成注释的文档
  
  虽然代码做了非常详细的注释,但总有生成外部文档的要求,让任何人都可以理解,不看代码的功能。这方面的要求往往导致双重工作量的评论。幸运的是,有工具可自动读取代码注释,然后生成接口代码和其他文档详细!帮助工程师避免在市场上做同样的工作!有这样的免费工具doxygen的例子。当开发人员编写他们的代码时,他们将指定如何格式化它们的注释,并提供他们想要详细说明的外部文档的内容。然后他们可以运行在软件真实反映生成HTML doxygen注释,RTF或PDF文件。精彩的是,如果你更新了评论,外部文件会自动更新!
  
  二、创建注释标准
  
  像编写代码,对代码开发的注释和文档应该有一个标准。因为评论不能有很多的标准条款,所以特别推荐接近标准的代码。也就是要确保各成员在同一个组中注释和归档,确保使用的易用性。开发商应该把重点放在解决设计问题上,而不是努力去了解这些评论。相关阅读:嵌入式培训之android与linux的三大区别
  
  三、不写显示的注释

  
  虽然开发者写代码注释,但只有当评论被重复变量或函数名时,就会特别刺激。注释应该是描述性的文本,您需要提供更多的含义比明确的细节!提供尽可能多的信息,但不要忘记提及相关的变量或函数和相关的。开发者应该能够理解只是通过阅读一个评论的行为的软件。
  
  四、使用文档模板
  
  确保遵循标准注释最简单的方法是为头文件、源文件和支持文件创建模板。在创建新模块时,可以从模板开始,然后添加相关信息。这将有助于确保块文件信息,视频,功能,和具有相同格式的注释变量。这种方法最大的优点是能够节省大量的时间,并有助于减少一个模块的发生,另一个拷贝复制并粘贴模板伪错误。为了使生活更容易,我特意开发了一个模板,可以用来定义头文件和源文件。
  
  五、保持注释的美化
  
  为了避免误解,并确保代码的缺陷,使代码更容易阅读和维护的结构是非常重要的。注意,太。结构化的注释偶尔会使眼睛难以捕捉到注释,更难以捕捉到的内容是不正确的。注释应格式化,以便如果打印出来的代码(虽然现在很少打印,但我偶尔仍然打印代码)将不会被分配到几页。在大块的评论(如文件或函数头注释),如果你使用块的指标,不包含任何尾部字符(如#或*),不仅使文档更新更难。
  
  以上就是达内南京嵌入式培训针对代码注释提出的一些技巧,希望对在相关的工作人员能有帮助,相信在上述技巧的帮助下,嵌入式开发工程师的开发工作将会更加的轻松。

  • 上一篇:网站栏目安排需要注意的几个方面
  • 下一篇:嵌入式系统开发的四个技巧
  • 达内南京新街口中心:南京市玄武区洪武北路121号苏苑大厦5楼  联系电话:025-66610022

    版权所有 南京达内软件有限公司 苏ICP备12008613号-4