OpenFOAMC++StyleGuide中文版.pdfVIP

/openfoamresearch   OpenFOAM C++编程规范指南 （OpenFOAM C++ Style Guide ） 苏军伟译     1    /openfoamresearch 目录  1 OpenFOAM C++样式指南  3  1.1 概论 3  1.2 H 头文件  4  1.3 C 文件  4  1.4 编程实践  5  1.5 条件语句  5  1.6 for 和while 循环语句  5  1.7 forAll, forAllIter, forAllConstIter, 等循环操作宏  6  1.8 长语句的分行书写  6  1.9 数学表达和逻辑表达  6  1.10 概论 7  1.11 Doxygen 特有命令  8  1.12 HTML 特有命令  8  1.13 对命名空间进行文档编写  9  1.14 对Typedefs 和通过宏定义的类进行文档编写  9  1.15 应用程序的文档书写  9  1.16 拼写 9      2    /openfoamresearch     1 OpenFOAM C++程序设计规范指南 1.1 概论 • 每行最多80 个字符 • 每行缩进4 个空格 • 利用空格进行缩进，而不是用tab 键 • 结尾避免有空格 • 控制结构的单元体（if，else，while ，等)尽量采用括号括起来，break 或者continue 可除 外。 • 流输出 永远在输出开始后第四个字符开始。 比如 Info // Info 有四个字符。译者注 os //os 只有两个字符，所以加两个空格。译者注 因此 WarningIn(className::functionName()) Warning message // 对于比较长的输出，另外起一行。译者注 不应该是 WarningIn(className::functionName()) Warning message //这里之前和WarningIn 开头没哟空4 个字符。译者注 • 如果该区没有内容，就将文件头名字去掉，就算将来要在该部分添加新的内容，也不例 外。因此需要将下面的删除 （因为里面文件头下面没有内容，译者注） //* * * * * * * * * * * * * Private Member Functions* * * * * *