Choose your operating system:
Windows
macOS
Linux
为了提升虚幻引擎API参考手册的帮助效果,我们在内容中新增了代码片段;它们是示例代码中的代码块,旨在展示C++ API在虚幻引擎项目中的用法。如果你想为 虚幻引擎API参考手册 贡献代码片段,请遵循本规范。
一般标准
-
代码片段必须遵循 代码规范 。
-
注释应符合代码规范。
-
应充分对代码片段进行注释。
-
适当时,请让代码片段的含义不言自明(即自文档化)。
-
代码片段应保持简洁,不得超过25行。
-
尽量减少行数,以便阅读者无需换行或滚动查看。
-
将包含代码片段的项目压缩成压缩文件,然后提交到GitHub,路径为 EpicGames/Unreal Engine 。
函数
-
任何给定函数均应拥有一个代码片段。
-
函数必须生成有意义且用户可见的输出。
-
切勿使用难以解译的表达式模糊函数的意义。
-
请尽可能清晰展示函数,同时提供合理、简单的用例。
表达式和语句
-
切勿通过牺牲表达式的可读性来换取性能优化。
-
表达式和语句应有意义、清晰且易懂。
-
条件表达式应模仿自然语言的表达逻辑。
片段块
-
切勿在片段块中两个文本行之间放置两个连续空行。
-
将
///CODE_SNIPPET_START:<class1::func1><classN::funcN>
置于代码片段之上。 -
将
///CODE_SNIPPET_END
置于代码片段之下。
质量保证
-
使用
#UE4Docs
标记代码片段。 -
所有代码片段在发布前都应进行代码检查。
-
代码段发布后,应对其内容进行维护,以保证清晰、准确。