FreeCAD的代码风格

FreeCAD编码风格指南

文本编码与空格使用

• 源代码默认使用"utf8"编码。
• 缩进应使用4个空格，避免使用TAB。
• 行尾符应采用Windows风格的\r\n。
• 对于未测试的shell脚本，若所有EOL均为\n，则可以使用。

C++编码风格

• 风格接近于Qt，例如类构造函数的定义方式。
• 成员变量命名需加前缀，如i(整数)、s(字符串)等。
• 每个模块应使用命名空间，并采用"<ModuleName>Export"的命名方式。
• 类名需使用驼峰命名法。
• 私有成员变量和方法名以小写字母开头。
• 不使用TAB，使用4个空格进行缩进。

与Qt风格不同之处

• FreeCAD使用getPropertyName()，不同于Qt的propertyName()。
• 函数参数遵循“类型前缀+有意义名称”的模式。
• 使用C++ STL和boost库，但为用户提供更高层次的Qt风格API。

Python编码风格

• 对于暴露给其他用户的API，应采用QtSide编码风格。
• 内部代码可以使用Python标准编码风格。
• 属性名以大写字母开头。
• 类名遵循命名约定，如Command<SpecificName>、ViewProvider<><>、TaskPanel_PrivateClassName。

风格检查器

• 推荐使用PyCXX以提高Python 2.x和3.x之间的兼容性。
• 应使用pep8和pyflake来检查编码风格。
• Python IDE可能会与flake8产生冲突，并避免在C++ IDE中出现尾随空格。

命名不一致问题

• 需要注意Python和C++文件中可能出现的命名不一致，如大小写和拼写错误。

        总结：该指南确保了FreeCAD项目中代码的一致性和可读性，同时促进了项目合作与代码质量的提升。开发者需遵循这些规范进行编码。