编写代码片段

虚幻引擎API参考手册代码片段的编写规范

Windows
MacOS
Linux
前置主题

此页面假定您已掌握以下主题的前置知识。请在继续之前先阅读它们。

在继续学习本指南前:

为了提升虚幻引擎API参考手册的帮助效果,我们在内容中新增了代码片段;它们是示例代码中的代码块,旨在展示C++ API在虚幻引擎项目中的用法。如果你想为虚幻引擎API参考手册 贡献代码片段,请遵循本规范。

一般标准

  1. 代码片段必须遵循代码规范

  2. 注释应符合代码规范。

  3. 应充分对代码片段进行注释。

  4. 适当时,请让代码片段的含义不言自明(即自文档化)。

  5. 代码片段应保持简洁,不得超过25行。

  6. 尽量减少行数,以便阅读者无需换行或滚动查看。

  7. 将包含代码片段的项目压缩成压缩文件,然后提交到GitHub,路径为EpicGames/Unreal Engine

函数

  1. 任何给定函数均应拥有一个代码片段。

  2. 函数必须生成有意义且用户可见的输出。

  3. 切勿使用难以解译的表达式模糊函数的意义。

  4. 请尽可能清晰展示函数,同时提供合理、简单的用例。

表达式和语句

  1. 切勿通过牺牲表达式的可读性来换取性能优化。

  2. 表达式和语句应有意义、清晰且易懂。

  3. 条件表达式应模仿自然语言的表达逻辑。

片段块

  1. 切勿在片段块中两个文本行之间放置两个连续空行。

  2. ///CODE_SNIPPET_START:<class1::func1><classN::funcN> 置于代码片段之上。

  3. ///CODE_SNIPPET_END 置于代码片段之下。

质量保证

  1. 使用 #UE4Docs 标记代码片段。

  2. 所有代码片段在发布前都应进行代码检查。

  3. 代码段发布后,应对其内容进行维护,以保证清晰、准确。

Select Skin
Light
Dark

欢迎来到全新虚幻引擎4文档站!

我们正在努力开发新功能,包括反馈系统,以便您能对我们的工作作出评价。但它目前还未正式上线。如果您对此页面有任何意见与在使用中遭遇任何问题,请前往文档反馈论坛告知我们。

新系统上线运行后,我们会及时通知您的。

发表反馈意见