機械翻訳について

コーディング標準

このプロジェクトでは、次のコーディング標準を採用しています:

  • コードは、「Google Javaスタイル」と同じOracle / WebLogic標準を使用して書式設定する必要があります。
  • Javadocは、すべてのパブリック・パッケージ、クラスおよびメソッドに対して指定する必要があり、すべてのパラメータおよび戻り値を含める必要があります。 Javadocは、すでにドキュメント化されているメソッドをオーバーライドまたは実装するメソッドには必要ありません。
  • すべての些末でないメソッドには、LOGGER.entering()およびLOGGER.exiting()コールを含める必要があります。
  • LOGGER.exiting()コールには、メソッドから戻される値を含める必要があります。ただし、その値に資格証明またはその他の機密情報が含まれている場合を除きます。
  • ログに記録されたすべてのメッセージは、リソース・バンドルsrc/main/resources/Operator.propertiesおよびsrc/main/java/oracle/kubernetes/operator/logging/MessageKeys.javaでアイテム化されたキーを使用して国際化する必要があります。
  • オペレータの初期化後、すべてのオペレータ作業を非同期呼び出しモデルを使用して実装する必要があります。 特に、ワーカー・スレッドでは、sleep()、IOまたはロック・ベースのブロック・メソッドを使用しないでください。

コード・フォーマット・プラグイン

次のIDEプラグインは、コードの書式設定標準に準拠するために使用できます

IntelliJ

「IntelliJプラグイン」はプラグイン・リポジトリから入手できます。

プラグインはデフォルトで有効になります。 現在のプロジェクトで無効にするには、File > Settings... > google-java-format Settings (またはmacOS上のIntelliJ IDEA > Preferences... > Other Settings > google-java-format Settings)に移動し、「google-java-formatの有効化」チェック・ボックスの選択を解除します。

新規プロジェクトでデフォルトで無効にするには、File > Other Settings > Default Settings...を使用します。

有効にすると、通常の「コードの再フォーマット」アクションが置き換えられます。これは、「コード」メニューまたはCtrl+ Alt+ L (デフォルト)キーボード・ショートカットからトリガーできます。

インポート順序はこのプラグインでは処理されません。 インポート順序を修正するには、「IntelliJ Java Googleスタイル・ファイル」をダウンロードし、ファイル→設定→エディタ→コード・スタイルにインポートします。

Eclipse

「Eclipseプラグイン」は、リリース・ページからダウンロードできます。 これをEclipse 「ドロップ・イン・フォルダ」にドロップして、プラグインをアクティブ化します。

このプラグインは、Eclipse > Preferences > Java > Code Style > Formatter > Formatter Implementationで構成可能なgoogle-java-formatフォーマッタ実装を追加します。