アプリケーションを開発する際、メソッドの詳細（例えば、メソッドの動作の説明、構文、メソッドに渡されるパラメータの定義など）に素早くアクセスできると非常に便利な場合があります。これは、コンパイルされたコンポーネントを使用する場合に、より重要になります。メソッドの中身を見ることができないので、使い方を理解するためにはそのドキュメントに頼るしかないのです。
4D v18 R3では、エクスプローラーのダイアログが強化され、プロジェクトデータベースのドキュメントが利用できるようになりました。
ドキュメントは、メソッドやフォームと同じ名前のファイルで、ドキュメントフォルダに保存されます。ドキュメントの新しいフォーマットは、Markdownです。
なぜ、Markdownなのか？
Markdown言語はテキストをフォーマットすることができ、非常にシンプルな構文を持っています。したがって、ドキュメントはその解釈を中断することなく、読みやすく、書きやすいものとなります。
多くのツールはドキュメントのフォーマット用にMarkdownを使用しています。例えば、GitHubは組み込みのMarkdownインタプリタを提供しています。
4Dでのドキュメンテーション
ドキュメントは、以下のものに利用できます。
- プロジェクトメソッド
- データベースメソッド
- トリガーメソッド
- プロジェクトフォームメソッド
- テーブルフォームメソッド
- クラス
バイナリデータベースをプロジェクトとしてエクスポートすると、既存のドキュメントがMarkdown形式のファイルで保存されます。
プロジェクトデータベースのドキュメントファイルを作成または編集するには、”作成 “ボタンをクリックするか、エクスプローラで “ドキュメントを編集 “メニュー項目を選択します。
4Dは、対応するファイルを作成し、デフォルトのエディターで開きます。このファイルにはテンプレートが含まれています。
<!-- Type your summary here --> ## Description ## Example ```4d Type your example here ```
最初の行でHTMLのコメントタグが使われているのがわかると思います。この情報は、メソッドの上にカーソルを置くと、メソッドエディタに表示されます。ファイルの残りの部分は、エクスプローラの「ドキュメント」タブに表示されます。
例
例としてgetWeekday メソッドを使用すると、次のようになります。
次回のブログでは、コメントを利用して独自のコンポーネントのドキュメントを作成する方法を紹介します。ご期待ください。