メインコンテンツまでスキップ
非公開のページ
このページは非公開です。 検索対象外となり、このページのリンクに直接アクセスできるユーザーのみに公開されます。
バージョン: 3.1

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

コード内で FE/BE パラメータや変数を追加、変更、削除する際は、必ずドキュメントを更新してください。 FE configuration, BE configuration, System variables.

パラメータや変数の説明には通常、以下のフィールドが含まれます。

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

パラメータの説明​

意味​

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

依存関係​

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

有効な値​

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

リスク​

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

チューニング方法​

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

廃止声明​

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

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

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

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

パラメータ名の変更​

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