FE/BE パラメーターと変数の記述テンプレート

コード内で FE/BE パラメーターや変数を追加、変更、削除する際は、ドキュメントを更新することを忘れないでください: FE configuration, BE configuration, System variables.

パラメーターまたは変数の説明には通常、次のフィールドが含まれます:

• Default: このパラメーターのデフォルト値。異なるバージョンでデフォルト値が異なる場合は、この情報を明確に指定してください。
• Type: 許可されるデータ型
• Unit: このパラメーターに単位がない場合は空のままにできます。
• Value range: このパラメーターに値の範囲がある場合のみ必要です。
• Is mutable: このパラメーターが動的に変更可能かどうか、FE/BE パラメーターの場合のみ必要です。
• Description: このパラメーターの説明、意味、有効な値、依存関係、リスク、チューニング方法、廃止声明を含みます。
• Introduced in: このパラメーターが導入されたバージョン、3 桁のバージョンまで正確に。

パラメーターの説明

意味

• このパラメーターは何に使用され、どのシナリオで使用されるか。
• このパラメーターが既存のパラメーターと似ている場合、それらの違いは何か？

依存関係

• このパラメーターが他のパラメーターに依存しているか（つまり、他のパラメーターが設定または有効化されていないと、このパラメーターが効果を発揮しない）
• このパラメーターが他のパラメーターの前提条件であるか
• このパラメーターが他のパラメーターと相互排他的であるか

有効な値

このパラメーターに複数の値がある場合、それぞれの値を説明します。

リスク

• このパラメーターを使用することでリスクがあるかどうか
• このパラメーターに値の範囲がある場合、上限/下限を超えた場合に何が起こるか
• このパラメーターが大きすぎるまたは小さすぎる値に設定された場合に何が起こるか

チューニング方法

エラーが発生した場合、このパラメーターをどのように調整するか。

廃止声明

このパラメーターが削除された場合:

• 削除された理由を説明
• 別のパラメーターで置き換えられるかどうか
• このパラメーターと共に削除される機能

デフォルト値/単位の変更

パラメーターのデフォルト値または単位が変更された場合、その変更理由を説明します。

パラメーター名の変更

• パラメーター名が変更された理由
• 互換性の問題が発生するかどうか。システムが互換性の問題にどのように対処するか。

ユーザーに見えないパラメーター

新しいパラメーターや変数がユーザーに見えない場合でも、ドキュメントに説明を追加し、コメントアウトすることをお勧めします。これは、このパラメーターをユーザーから隠すためですが、内部ユーザー（RD と DBA）がこのパラメーターの意味と使用法を理解するのに役立ちます。