プロジェクトのデータベースコンポーネントのための独自のドキュメントを構築

以前のブログ記事で、エクスプローラーにメソッドのドキュメントが戻ってきたことを紹介しました。さらに進化して、コンポーネントのドキュメントとして使用したいと思いませんか？このブログでは、その方法をご紹介します。

ソースコードとドキュメントの共有

コンポーネント・ソースをプロジェクト・データベースと共有することは、とても簡単です（例：GitHub経由）。使い方を説明するためには、ドキュメントが必須です。エクスプローラ内のドキュメントはMarkdownファイルで保存されているので、コンポーネントのドキュメント作成に利用することができます。

GitHubを利用すれば、ドキュメント用のミニサイトを作ることができます。各メソッドのドキュメントへのリンクを含む README ファイルを作成するだけです。そして、リポジトリの設定で、GitHubのページを有効にします。

ほら!

コンパイルされたコンポーネントとドキュメンテーション

アプリケーションのビルド “ダイアログでコンポーネントやコンパイルされたアプリケーションをビルドすると、”ドキュメント “フォルダが自動的に最終プロジェクトフォルダへコピーされます。

開発者があなたのコンポーネントをデータベースに統合するとき、4D のエクスプローラで直接ドキュメントを見ることができます。