KlayGE - Recent changes [en]

C++代码风格指南

2012-05-19T12:11:09Z

User:Jenniegreengin021

2012-05-19T11:10:19Z

New user account

User:PorchPorch814

2012-05-19T09:02:31Z

New user account

User:Backlink22tr

2012-05-19T00:17:30Z

New user account

User:Online money make

2012-05-17T22:32:15Z

New user account

User:Life quote

2012-05-17T19:52:51Z

New user account

User:PenickSommerville481

2012-05-16T19:46:08Z

New user account

User:SelenaDobbs74

2012-05-14T18:47:12Z

New user account

C++ style guide

2012-05-14T14:57:36Z

C++代码风格指南

2012-05-14T14:57:22Z

Show changes

User:Zebulj

2012-05-14T05:01:25Z

blocked [[Zebulj (Talk | contribs)]] with an expiry time of indefinite (account creation disabled) Spamming links to external sites

User talk:Zebulj

2012-05-14T05:01:12Z

deleted "[[User talk:Zebulj]]" content was: "I'm researching opportunities for search engine optimization and submiting optimised sites to search engines. If you need optimization and submition, you can reach ..." (and the only contributor was "Zebulj")

User:PreciadoAndrews172

2012-05-13T19:24:30Z

New user account

History

2012-05-13T15:56:10Z

发展历程

2012-05-13T15:55:23Z

例子程序

2012-05-13T15:55:07Z

KlayGE

2012-05-13T15:54:32Z

首页

2012-05-13T15:54:14Z

Начало

2012-05-13T15:53:40Z

FAQ

2012-05-13T15:52:49Z

Programming guide

2012-05-13T15:52:13Z

Installation

2012-05-13T15:51:56Z

Main Page

2012-05-13T15:51:07Z

Third-party Libraries and Tools

2012-05-13T15:50:46Z

moved [[Third-party Libraries and Tools]] to [[Third-party libraries and tools]] [redirect suppressed]

工具集

2012-05-13T15:50:02Z

Toolset

2012-05-13T15:49:37Z

Talk:Juda Texture

2012-05-13T15:49:10Z

moved [[Talk:Juda Texture]] to [[Talk:Juda texture]] [redirect suppressed]

Juda Texture/ru

2012-05-13T15:49:10Z

moved [[Juda Texture/ru]] to [[Juda texture/ru]] [redirect suppressed]

Juda Texture/en

2012-05-13T15:49:09Z

moved [[Juda Texture/en]] to [[Juda texture/en]] [redirect suppressed]

Juda Texture

2012-05-13T15:49:09Z

moved [[Juda Texture]] to [[Juda texture]] [redirect suppressed]

C++ style guide

2012-05-13T15:05:13Z

Static and Global Variables:

C++代码风格指南

2012-05-13T15:04:37Z

User:BarclayPopovich714

2012-05-13T05:30:18Z

New user account

User:OthellaLuciano289

2012-05-13T02:58:18Z

New user account

User:CatlinWideman811

2012-05-13T00:07:05Z

New user account

User:JoellaCotten17

2012-05-12T16:30:46Z

New user account

User:Zebulj

2012-05-12T14:30:17Z

New user account

User:AllmonAllan875

2012-05-12T13:29:39Z

New user account

@@ Line 421: / Line 421: @@
 == 默认构造函数 ==
-You must define a default constructor if your class defines member variables and has no other constructors. Otherwise the compiler will do it for you, badly.
+如果你的类定义了成员变量，但没有别的构造函数，就必须定义一个默认构造函数。否则编译器会把这件事情搞得很遭。
-'''Definition:'''
+'''定义：'''
-The default constructor is called when we new a class object with no arguments. It is always called when calling new[] (for arrays).
+当不带参数新建一个类对象的时候，默认构造函数就会被调用。当调用new[]申请数组的时候，默认构造函数总是会被调到。
-'''Pros:'''
+'''优点：'''
-Initializing structures by default, to hold "impossible" values, makes debugging much easier.
+把结构体默认初始化成“不可能”的值，可以简化调试。
-'''Cons:'''
+'''缺点：'''
-Extra work for you, the code writer.
+写代码需要额外的工作。
-'''Decision'''
+'''决定'''
-If your class defines member variables and has no other constructors you must define a default constructor (one that takes no arguments). It should preferably initialize the object in such a way that its internal state is consistent and valid.
+如果你的类定义了成员变量，但没有别的构造函数，就必须定义一个默认构造函数（没有参数的）。最好能把对象初始化成内部状态是一致而且有效的。
-The reason for this is that if you have no other constructors and do not define a default constructor, the compiler will generate one for you. This compiler generated constructor may not initialize your object sensibly.
+这么做的原因是如果你没有其他构造函数而且也没有默认构造函数，编译器会产生一个。编译器产生的构造函数可能无法聪明地把你的对象初始化得很好。
-If your class inherits from an existing class but you add no new member variables, you are not required to have a default constructor.
+如果你的类继承了另一个类，但你增加了新的成员变量，不是一定要加一个默认构造函数。
 == 显式构造函数 ==

@@ Line 409: / Line 409: @@
 The problems with doing work in constructors are:
-*There is no easy way for constructors to signal errors, short of using exceptions (which are forbidden).
+*There is no easy way for constructors to signal errors, short of using exceptions.
 *If the work fails, we now have an object whose initialization code failed, so it may be an indeterminate state.
 *If the work calls virtual functions, these calls will not get dispatched to the subclass implementations. Future modification to your class can quietly introduce this problem even if your class is not currently subclassed, causing much confusion.

@@ Line 28: / Line 28: @@
 '''3.11.0 (2010.12.23)'''
   '''Support OpenGL 4.1'''
-  '''Add [[Juda Texture]], a Tera-texel texture system'''
+  '''Add [[Juda texture/en|Juda texture]], a Tera-texel texture system'''
   Enhanced stereo rendering, support 3D glasses
   Remove D3D9 and D3D10 plug-in. The rendering task under WinXP is taken over by OpenGL plug-in

@@ Line 28: / Line 28: @@
 '''3.11.0 (2010.12.23)'''
   '''支持OpenGL 4.1'''
-  '''增加了[[Juda Texture]]，最大支持1M*1M大小的纹理'''
+  '''增加了[[Juda texture]]，最大支持1M*1M大小的纹理'''
   增强立体显示，支持立体眼镜
   去掉了D3D9和D3D10插件，WinXP下由OpenGL插件接管

@@ Line 161: / Line 161: @@
 = JudaTex Viewer =
 [[File:Judatexviewer.jpg|200px|thumb|right|Juda Texture Viewer]]
-[[Juda Texture]]查看器。
+[[Juda texture]]查看器。
 '''难度'''
@@ Line 167: / Line 167: @@
 '''技术点'''
-#[[Juda Texture]]
+#[[Juda texture]]
 #鼠标交互

@@ Line 45: / Line 45: @@
 * 基于distance的[[字体系统|字体]]生成器，可以把矢量字体转换成引擎使用的字体格式
 * FXML2Shader工具，把[[FXML]]的特效脚本转换成HLSL或Cg
-* [[Juda Texture]]打包工具，把多张普通纹理打包成一个Juda Texture
+* [[Juda texture]]打包工具，把多张普通纹理打包成一个Juda texture
 * Color Grading纹理生成工具
 * Normals Fitting生成器

@@ Line 24: / Line 24: @@
 这些是[[KlayGE]]原创的特色技术
 * [[特效系统]]：跨平台的渲染特效系统，可以高效地包装各种特效。
-* [[Juda Texture]]：可以存储和动态读取1T个像素的虚拟纹理系统。
+* [[Juda texture]]：可以存储和动态读取1T个像素的虚拟纹理系统。
 * [[字体系统]]：兼有矢量和点阵字体的双重优点。
 * [[glloader]]：自动载入所有支持的OpenGL扩展，并可以修补一些老驱动带来的兼容问题。

@@ Line 23: / Line 23: @@
 Это отличительные технологии [[KlayGE/ru|KlayGE]]
 * [[Effect system]]: Кросс-платформенная система визуализации эффектов.
-* [[Juda Texture/ru|Juda Texture]]: Текстурная система Tera-texel.
+* [[Juda texture/ru|Juda texture]]: Текстурная система Tera-texel.
 * [[Font system]]: Поддержка растровых и векторных шрифтов.
 * [[glloader/ru|glloader]]: Загрузка всех поддерживаемых OpenGL расширений автоматически. Может исправить проблемы совместимости со старыми драйверами.

@@ Line 5: / Line 5: @@
 == Q: You are the only developer of [[KlayGE]]? ==
-A: Yes and no. Almost all of the development is completed by myself. However, during this process, some [[Third-party Libraries and Tools|3rd-party libraries]] are used, for example 7zip encoding/decoding. Many friends also provide their indispensable advices in the development. From 3.12, many features are done by team members. See [[History]].
+A: Yes and no. Almost all of the development is completed by myself. However, during this process, some [[Third-party libraries and tools|3rd-party libraries]] are used, for example 7zip encoding/decoding. Many friends also provide their indispensable advices in the development. From 3.12, many features are done by team members. See [[History]].
 == Q: Where can I find [[KlayGE]]’s documents? ==

@@ Line 1: / Line 1: @@
 = General =
-* [[Third-party Libraries and Tools]]
+* [[Third-party libraries and tools]]
 * [[Directory structure]]
 * [[Compilers tested]]

← Older revision		Revision as of 15:51, 13 May 2012
Line 1:		Line 1:
−	Before compiling [[KlayGE]], you can run build_external.py to build and install [[Third-party ~~Libraries~~ and ~~Tools~~\|third-party libraries and tools]].	+	Before compiling [[KlayGE]], you can run build_external.py to build and install [[Third-party libraries and tools\|third-party libraries and tools]].

	Since [[KlayGE]] 3.12.0, include and lib paths are set up inside the project files. After extraction, just open the corresponding project file under "Build" directory, [[KlayGE/en\|KlayGE]] itself can be built directly. Or you can run build_all.py to do that job.		Since [[KlayGE]] 3.12.0, include and lib paths are set up inside the project files. After extraction, just open the corresponding project file under "Build" directory, [[KlayGE/en\|KlayGE]] itself can be built directly. Or you can run build_all.py to do that job.

@@ Line 16: / Line 16: @@
 * [[System requirements]]
 * [[Installation]]
-* [[Third-party Libraries and Tools]]
+* [[Third-party libraries and tools]]
 * [[History]]
 * [[FAQ]]
@@ Line 24: / Line 24: @@
 These are [[KlayGE/en|KlayGE]]'s original distinguishing techniques
 * [[Effect system]]: Cross platform rendering effect system.
-* [[Juda Texture/en|Juda Texture]]: A Tera-texel texture system.
+* [[Juda texture/en|Juda Texture]]: A Tera-texel texture system.
 * [[Font system]]: Have both benefits from vector font and bitmap font.
 * [[glloader/en|glloader]]: Load all supported OpenGL extensions automatically. Can fix some old drivers' compatibility problems.

@@ Line 10: / Line 10: @@
 * Distance-based font generator, converts a vector font to the format that engine uses.
 * FXML2Shader tool, converts a FXML effect script to HLSL or Cg shader.
-* [[Juda Texture/en|Juda Texture]] packer, packing multiple textures into a single Juda Texture.
+* [[Juda texture/en|Juda texture]] packer, packing multiple textures into a single Juda Texture.
 * Color Grading texture generator.
 * Normals Fitting generator.

@@ Line 385: / Line 385: @@
 Likewise, the order in which destructors are called is defined to be the reverse of the order in which the constructors were called. Since constructor order is indeterminate, so is destructor order. For example, at program-end time a static variable might have been destroyed, but code still running -- perhaps in another thread -- tries to access it and fails. Or the destructor for a static 'string' variable might be run prior to the destructor for another variable that contains a reference to that string.
-As a result we only allow static variables to contain POD data. This rule completely disallows vector (use C arrays instead), or string (use const char []).
+As a result we only allow static variables to contain POD data. This rule completely disallows vector (use C arrays instead), or string (use char const []).
 If you need a static or global variable of a class type, consider initializing a pointer (which will never be freed), from either your main() function or from pthread_once(). Note that this must be a raw pointer, not a "smart" pointer, since the smart pointer's destructor will have the order-of-destructor issue that we are trying to avoid.

@@ Line 332: / Line 332: @@
 == 局部变量 ==
-Place a function's variables in the narrowest scope possible, and initialize variables in the declaration.
+把函数的变量放在尽量小的范围内，并在声明的时候初始化。
-C++ allows you to declare variables anywhere in a function. We encourage you to declare them in as local a scope as possible, and as close to the first use as possible. This makes it easier for the reader to find the declaration and see what type the variable is and what it was initialized to. In particular, initialization should be used instead of declaration and assignment, e.g.
+C++允许你在函数的任何地方声明变量。我们鼓励把变量声明在尽可能小的范围内，并且尽量靠近第一次使用的地方。这会让读者更容易找到声明、看到变量的类型、以及它被初始化成什么值。特别是，应该使用初始化而不是声明后赋值。比如：
 {{Cross}}
 <pre>
 int i;
-i = f();	// Bad -- initialization separate from declaration.
+i = f();	// 错误 -- 初始化和声明分开了
 </pre>
 {{Tick}}
 <pre>
-int j = g();	// Good -- declaration has initialization.
+int j = g();	// 正确 -- 声明就初始化
 </pre>
-Note that MSVC and gcc implements for (int i = 0; i < 10; ++ i) correctly (the scope of i is only the scope of the for loop), so you can then reuse i in another for loop in the same scope. It also correctly scopes declarations in if and while statements, e.g.
+注意，MSVC和gcc正确地实现了for (int i = 0; i < 10; ++ i)（i的生命期只在for循环的范围内），所以你在同范围的其他循环仍可以重用i。在if和while语句内，声明范围也是这样的规则，比如：
 <pre>
@@ Line 355: / Line 355: @@
 </pre>
-There is one caveat: if the variable is an object, its constructor is invoked every time it enters scope and is created, and its destructor is invoked every time it goes out of scope.
+有一个需要留心的地方：如果变量是个对象，那么在每一次进入范围和建立的时候都会调用它的构造函数，每一次出范围的时候都会调用它的析构函数。
 <pre>
-// Inefficient implementation:
+// 低效的实现：
 for (int i = 0; i < 1000000; ++ i)
+{
-	Foo f;  // My ctor and dtor get called 1000000 times each.
+	Foo f;  // 构造和析构各会调用1000000次
 	f.DoSomething(i);
+}
 </pre>
-It may be more efficient to declare such a variable used in a loop outside that loop:
+把这样的变量声明在循环外会更高效：
 <pre>
-Foo f;  // My ctor and dtor get called once each.
+Foo f;  // 构造和析构只调用一次
 for (int i = 0; i < 1000000; ++ i)
+{
@@ Line 378: / Line 378: @@
 == 静态和全局变量 ==
-Static or global variables of class type are forbidden: they cause hard-to-find bugs due to indeterminate order of construction and destruction. On some platform, (e.g. Android), a global variables with constructor crashes all the time.
+class类型的静态和全局变量是禁止的：由于构造和析构的不确定顺序产生的bug往往难以寻找。在一些平台上（比如Android），带有构造函数的全局变量会直接造成崩溃。
-Objects with static storage duration, including global variables, static variables, static class member variables, and function static variables, must be Plain Old Data (POD): only ints, chars, floats, or pointers, or arrays/structs of POD.
+含有静态存储周期的对象，包括全局变量、静态变量、静态类成员变量、以及函数静态变量，必须是纯数据的类型（POD）: int、char、floats、指针、或POD的数组或结构体。
-The order in which class constructors and initializers for static variables are called is only partially specified in C++ and can even change from build to build, which can cause bugs that are difficult to find. Therefore in addition to banning globals of class type, we do not allow static POD variables to be initialized with the result of a function, unless that function (such as getenv(), or getpid()) does not itself depend on any other globals.
+静态变量的类构造函数和初始化调用顺序在C++中只是部分定义而已，甚至在不同次构建之间都会改变。这回产生很难跟踪的bug。因此除了禁止class类型的全局变量，我们也禁止静态的POD变量用函数的返回值来初始化，除非那个函数（比如getenv()或getpid()）本身不依赖于其他全局变量。
-Likewise, the order in which destructors are called is defined to be the reverse of the order in which the constructors were called. Since constructor order is indeterminate, so is destructor order. For example, at program-end time a static variable might have been destroyed, but code still running -- perhaps in another thread -- tries to access it and fails. Or the destructor for a static 'string' variable might be run prior to the destructor for another variable that contains a reference to that string.
+同样，析构函数的调用顺序被定义成了和构造函数调用相反的顺序。因为构造的顺序是不确定的，析构顺序也是不确定的。比如，在程序端一个静态变量可能已经被销毁了，但代码还在执行——可能在另一个线程——试图访问它，就会失败。或者一个静态string变量可能先于引用它的另一个变量之前析构。
-As a result we only allow static variables to contain POD data. This rule completely disallows vector (use C arrays instead), or string (use const char []).
+结果我们只允许静态变量包含POD数据。这个规则完全禁止了vector（使用C数组来代替），或字符串（使用char const []来代替）。
-If you need a static or global variable of a class type, consider initializing a pointer (which will never be freed), from either your main() function or from pthread_once(). Note that this must be a raw pointer, not a "smart" pointer, since the smart pointer's destructor will have the order-of-destructor issue that we are trying to avoid.
+如果你需要一个class类型的静态或全局变量，可以初始化一个指针（并且从来不释放）——要么从你的main()函数，要么从pthread_once()。注意那必须是个原始的指针，不是“智能”指针，因为智能指针的析构函数也会出现析构顺序问题，而那正是我们想避免的。
 = 类 =