コーディングスタイル
ONNX Runtimeコーディングスタイル
Section titled “ONNX Runtimeコーディングスタイル”このドキュメントでは、ONNX Runtimeのコーディングスタイルガイドラインについて説明します。
- コードは明確で、簡潔で、保守しやすいものにしてください。
- 意味のある変数名と関数名を使用してください。
- 不要な複雑さを避けてください。
- 適切な場合はコメントを追加して、コードを説明してください。
ONNX Runtimeは、C++コードにGoogle C++スタイルガイドを使用しています。ただし、いくつかの例外があります。
- インクルードガード：
#pragma onceを使用します。 - 例外：例外を使用します。
- RTTI：RTTIを使用します。
コードの書式設定にはclang-formatを使用します。.clang-formatファイルは、リポジトリのルートにあります。
コードをコミットする前に、clang-formatを実行してください。
clang-format -i <file>リンティング
Section titled “リンティング”コードのリンティングにはclang-tidyを使用します。.clang-tidyファイルは、リポジトリのルートにあります。
コードをコミ-ットする前に、clang-tidyを実行してください。
clang-tidy <file>Python
Section titled “Python”ONNX Runtimeは、PythonコードにPEP 8スタイルガイドを使用しています。
コードの書式設定にはblackを使用します。pyproject.tomlファイルは、リポジトリのルートにあります。
コードをコミットする前に、blackを実行してください。
black <file>リンティング
Section titled “リンティング”コードのリンティングにはflake8を使用します。.flake8ファイルは、リポジトリのルートにあります。
コードをコミットする前に、flake8を実行してください。
flake8 <file>