IEEE Standard 829-2008解析

第九章起作用的代码前面的章节通过例子提供了VTK的介绍。到现在很清楚VTK提供了创建强大的图形，成像，和可视觉化应用的功能性。因为你有权使用源代码，你可以通过添加你自己的类来扩展VTK。在用户手册的第三部分，我们给你展示了如何扩展VTK来适应你自己应用的需要。在本章我们通过引入你可能采用的代码协定开始——特别是如果你希望把你的代码贡献给VTK团体。我们也描述了你的对象必须实施的标准协定和方法，它们被合并进入VTK。在第三部分，我们讨论了组成VTK可视化流水线的过程和数据对象的实施细节，也有对可视化流水线执行的控制，而且描述了如何把VTK与不同的窗口系统相接。

9.1代码需要考虑的事项如果你开发你自己的滤波器或者其它的，我们鼓励你贡献源代码。你将必须从法律角度考虑它意味着什么，使用哪个编码风格和协定，如何从事贡献代码。给VTK贡献代码的情况版权条件来自BSD许可（看www.opensource.org）而且对于修改，复制，和重新分配源代码或者二进制没有限制，除了上面展示的四个bulleted条款，警告，和保护条款以外。除了注意这四个条款，遵守惯例的保护条款，和VTK/Patented/directory中少数类的商业专利限制，你可以使用任何形式的VTK，包括商业应用。

代码风格有许多可用的代码风格，但是我们坚持你只遵循一种。我们知道这是一个有异议的问题，但是我们已经发现保持一个一致的风格是重要的。一致的风格意味着代码容易读，调试，维护，测试，和扩展。它也意味着自动文件工具正确地操作。而且这些好处对于所有VTK用户是可得到的。这里是代码风格的一个总结。你可能希望研究VTK源代码来看看它像什么。

想了解C++编码规范的命名约定？你可以参考这篇文章。关于C编码风格命名规范的信息，可以在这里找到。Java编码风格规范的指南则在此处。

变量，方法，和类名字使用改变的capitalization大写来指出分离的单词。实例变量和方法总是使用一个大写字母开始。静态变量是另人失望的，但是应该使用一个大写字母开始。局部变量使用一个小写字母开始。SetNumberOfPoints（）或者PickList是一个方法名字和实例变量的例子。

类名字使用VTK前，接着是使用一个大写字母的类名字。vtkActor或者vtkPolyData是类名字。VTK前允许VTK类库与其它库混合。

显式的this->指针被用于方法。例子包括this->Visibility和this->Property和this->Execute （）。我们已经发现使用显式的this->指针提高了代码的理解和可读性。

变量，方法，和类名字应该被讲清楚。可以使用缩写，但是缩写的大写字母应该完整。vtkPolyDataConnectivityFilter或者vtkLODActor。

预处理程序变量使用大写字母来写。这些变量是唯一使用下划线来分离单词的。预处理程序变量也应该使用VTK_开始，如VTK_LARGE_FLOAT。

实例变量通常是protected或private类名字。通过Set/Get方法有权使用实例变量。注意VTK提供了Set/Get宏，它应该在任何可能的地方使用。（看VTK/Common/vtkSetGet.h得到实施，看.h头文件得到例子使用）

缩排风格可以特征化为“首行缩排的大括弧”风格。缩排风格是两个间隔，而且卷曲大括弧（范围分隔符）被放到下一行而且沿着代码缩进（i.e，卷曲大括弧使用代码排列起）

使用//来注释代码。方法是添加//Description：，每行都以//开始。