2.25.3 ドキュメント・コンポーネント

コンポーネントを簡単に再利用できるよう、注意を払ってドキュメントを作成する必要があります。詳細な最新の正確な記述がない場合は、コンポーネントは再利用できなくなるので、ドキュメントはとても重要です。

コンポーネントは、その記述とRDMLXコマンドのHELPパラメータにドキュメント化されます。

説明

コンポーネントを作成する場合は、新規コンポーネントダイアログに記述を入力する必要があります。当然のことながら、コンポーネントの記述は可能な限り正確で詳しくする必要があります。

後から記述を変更する場合は、[Repository Details]タブで実行できます。

RDMLXコマンド

BEGIN_COMコマンドのHELPパラメータを使用して開発者に関連するコンポーネントの情報をドキュメント化できます。

BEGIN_COM HELP('This form component contains a tabbed folder with tab sheets for employee contact information, salary and bank details and skills') LEFT(342) TOP(260)

 

この情報は、エディターの機能ヘルプで表示できます。

カスタム定義のイベント、メソッド、およびプロパティを作成する場合は、DEFINE_EVT、MTHROUTINE、DEFINE_PTY、およびDEFINE_MAPコマンドのHELPパラメータを使用してドキュメント化します。これらのカスタム定義のイベント、メソッド、およびプロパティは、[詳細]タブと、エディターの[ヘルプ]タブに表示されます。

例えば、マップされた出力値を持つイベントは、以下のように定義されます。

define_evt name(employee_created) help('This event is signaled whenever a new employy record is created.When this event is triggered, the employee number of the new employee is passed as THIS_EMP value.') 
 
define_map *output class(#empno) name(#this_emp) help('help for value')
 

 

これにより、詳細タブのイベントタブに以下のように表示されます。

イベントおよびイベントが引き渡す値も機能ヘルプに表示されます。