2022年2月17日木曜日

開発者によるコメントを使う

 Oracle APEX 19.2より、チーム開発という機能が提供されています。以前にチーム開発を初期化する方法について紹介したことがありますが(こちらの記事)、そこまではいらないかな、という方も多い気がします。ワークスペースには複数の開発者が登録されていても、それぞれのアプリケーションを作成は、ごく少人数で行われる方が一般的ではないでしょうか。

ちょっとした説明の記述に、開発者によるコメントの機能が使えます。

アプリケーション・ビルダーからは、吹き出しに+のアイコンのボタンをクリックして、コメントを操作するダイアログを開きます。


ページ・デザイナからは作成メニューを開いて、開発者によるコメントを実行します。

開発者によるコメントは、アプリケーションまたはページに紐づけられた文字列です。関連ページとしてページ番号を入力し(空白、カンマ区切りで複数ページ指定可)、コメントを記述します。

コメントの表示を選択して、すでに書かれているコメントを確認することができます。作成日開発者には、コメントを入力したときの情報が反映されています。


開発者であれば、他の開発者が作成したコメントでも、編集や削除できます。変更履歴はとられません。作成日、開発者は作成したときの情報なので、コメントを更新してもこれらの情報は更新されません。そういった機能が必要であれば、チーム開発を使うことになるのかな、と思います。


ワークスペースの管理者であれば、コメントの削除が表示されます。開発者または日付を指定して、まとめてコメントを削除できます。


ワークスペース・ユーティリティアプリケーション間レポートに含まれる開発者のコメントを開くと、ワークスペース内のすべてのアプリケーションの開発者のコメントを参照することができます。


対話モード・レポートの機能を使って、色々な条件にて一覧するコメントを絞り込めます。


このレポート画面からも、開発者によるコメントの編集および削除が可能です。


Oracle APEXのコンポーネント(ページ、リージョン、アイテム、ボタンなど)はほぼ全て、プロパティとしてコメントを持っています。大抵の場合、プロパティ・エディタの最後の設定項目(監査情報のすぐ上)に位置しています。


コンポーネントのコメントはアプリケーションが完成後も維持しておきたいコメント、開発者によるコメントは、アプリケーションが完成した後には削除するコメント、といった使い分けになるでしょう。

開発者によるコメントは、コンポーネントのコメントと異なり、アプリケーションのエクスポート時に除外することができます。


開発者によるコメントの機能紹介は以上になります。

Oracle APEXのアプリケーション作成の参考になれば幸いです。