Adapterプログラミングスタイル規則
AdapterはPython言語で記述されているため、Adapter開発者は Pythonプログラミング規則 を厳守する必要があります。
また、Adapterプログラミングのメンテナンス性と読みやすさを向上させるために、Adapterは本節で記述される規則も厳守する必要があります。
命名規則
-
クラス名はキャメルケースの形式で命名されます。例：
class AdapterWidget -
クラスのメンバー変数とメンバー関数は、アンダースコアで結合された小文字の単語を使用します。次に例を示します。例：
self.pick_count # Note that variables are generally nouns def start_viz(self): # Note that the function name is generally a verb + object pass -
クラスのメンバー変数とメンバー関数がクラス内でのみ使用される場合は、名前の前にアンダースコアを追加して、その名前をクラス外で使用することは推奨されていませんが、クラス外で使用できます。次に例を示します。
self._socket = socket() # Indicates that the _socket variable is only used inside the class def _init_widget(self): # Indicates that the _init_widget function is only used inside the class pass -
定数はアンダースコアで区切られた大文字の単語を使用します。次に例を示します。
ADAPTER_DIR = "D:/adapter_for_communication"
コメントの規則
コメントは適切な場所や必要な箇所にのみ追加するべきです。
-
一行コメント
一行コメントは#で始めます。
-
複数行コメント
複数行コメントは"""と"""の間に記述します。
-
関数、クラス、またはパッケージ紹介のコメント
コメントは、関数の下、クラスの下、またはパッケージの先頭に配置されます。次に例を示します。
def viz_is_running(self): """ Will be called when find viz is running during starting viz. """ class Adapter(QObject): """ Base class which encapsulates Viz/Vision/Hub/Robserver interfaces. """ """ Service base classes. """ import logging
ログ規則
ログは、トラブルシューティングや問題の分析に役立つ場合があります。ログには、プログラムの実行中に発生した情報、警告、エラーなどが記録されます。ログ情報を適切なタイミングで出力することは重要です。
Adapterは2つのログ出力方法をサポートしています。
-
print：この方法は、ログをコンソールに出力するだけです。実行時のリアルタイム監視には便利ですが、プログラムはエラーが発生するとメッセージが失われます。したがって、実際の生産で使用することはお勧めしません。
-
logging：この方法は、ログ表示形式をフォーマットすることをサポートし、ログをログファイルに保存することもサポートします（オプション機能）。したがって、この方法を使用することをお勧めします。