NS3的代码风格(一)
(参考官方文档,且与官方文档不完全相同)
我们在编写代码时常常花费许多时间来保持代码的风格。即使现在依然有许多风格迥异的代码和注释风格,因此,为了使之后的编程人员不需要学习、甚至改变之前的代码,我们需要一种统一的代码风格。
编程人员大多数并不是原作者,因此为了使之后的编程人员更加快速地对代码进行学习、补充,大量的注释是必不可少的。此外,统一的代码和注释风格能够令之后的编程人员更加轻松地理解、学习,从而编出有更少bug的代码。
因此,在编写NS3代码时我们需要遵循一种被大家所广泛接受的代码风格。这篇文章中我们提出了在编写NS3代码时的一些建议,以便使之后的NS3的代码风格统一。
以下提出的关于代码风格的建议并不是准则,其中的一些仍然有争议,相比起提出一种被大家接受的代码风格,本文的重点更偏向于使大家形成一种使用统一代码风格的思路。
这篇文章中提出的语法规则可以通过脚本utils/check-style.py
实施,这个脚本依赖于uncrustify版本。
1. 代码布局
代码布局参考C语言的布局GNU coding standard。(本文中的代码布局与原文并不相同,仅供参考)
void