コード スニペットの記述

Unreal Engine API リファレンス マニュアル用にコード スニペットを記述するための仕様です。

Windows
MacOS
Linux
Prerequisite Topics

This page assumes you have prior knowledge of the following topics. Please read them before proceeding.

このガイドを続ける前に、以下の操作を行ってください。

  • 最新の Visual Studio 2017 にアップデートしてください。

  • 学習リソース UE4Snippets Visual Studio 拡張機能をダウンロードおよびインストールしてください。

  • この Example Snippet Project をダウンロードし展開します。

Unreal Engine の API リファレンスを強化すべく、Unreal Engine プロジェクト向け C++ API の使用方法を例示する小さなサンプル コード群となるコード スニペットを追加します。Unreal Engine API リファレンス にコード スニペットを投稿していただける方は次の規格に従ってください。

規格の概略

  1. コード スニペットは コーディング規約 に従ってください。

  2. コメントの記述はコーディング規約に準拠してください。

  3. コード スニペットには十分なコメントを記述してください。

  4. 適切であればコード スニペットの自己文書化が可能です。

  5. コード スニペットは簡潔かつ 25 行未満にしてください。

  6. 読み手が行の折り返しやスクロール バーに依存する必要がないように行の長さを極力短くしてください。

  7. スニペット コードを ZIP 圧縮したプロジェクトを GitHub で EpicGames/Unreal Engine にサブミットしてください。

関数

  1. どの関数にもコード スニペットが 1 つ存在します。

  2. 関数はユーザーにとって見やすく意味の分かる出力をしなければなりません。

  3. 解釈しにくい式で関数の意図が曖昧にならないようにします。

  4. 合理的かつ単純なユースケースのために、関数の表現はできるだけ明瞭にします。

式と文

  1. パフォーマンス最適化のために式の可読性を犠牲にしないでください。

  2. 意味が分かりやすく明瞭かつ透明性の高い式と文を書いてください。

  3. 条件式は論理の自然言語式に倣ってください。

スニペット ブロック

  1. スニペット ブロック内の 2 行のテキスト間に連続した空の 2 行を配置しないでください。

  2. コード スニペットの上に ///CODE_SNIPPET_START:<class1::func1><classN::funcN> を配置してください。

  3. コード スニペットの下に ///CODE_SNIPPET_END を配置してください。

品質保証

  1. コード スニペットのサブミットに #UE4Docs をタグ付けしてください。

  2. すべてのコード スニペットは公開前にコード レビューされます。

  3. 公開後のコード スニペットのコンテンツは明瞭さと正確さのためメンテナンスされます。

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback