アプリケーション開発のコメント規約、ストアドは大丈夫?

 2017.10.23  株式会社システムインテグレータ

アプリケーション開発を行う際、コーディング規約、コメント規約ってあったりしますよね。しかしメインのプログラムの規約は細かく記載されていますが、データベース側のストアドプログラムは規約自体が無いなど、チェックが甘くなりがちです。また、規約にそぐわないプログラムのコメントは後々混乱を招く可能性があります。出来る限り修正していきたいところです。

 

SI Object Browserではストアドプログラムに記載されたコメントをリストアップして確認・編集の補助をする機能があります。ストアドプログラムの管理をしている担当の方は一度この機能で確認してみましょう。

comment03.png

【コメントチェック画面の画像】

コメントチェックを使うには

オブジェクトリストよりコメントチェック対象のストアドプログラムを選択します。

comment01.png

データベース開発に関するお役立ち資料

【オブジェクトリストにてストアドプログラムを選択している画像】

 そして右クリックメニューからコメントチェックを選択します。
(メインメニューの[オブジェクトリスト]からでも下記のメニューが出ます。)

comment02.png

【オブジェクトリストにて右クリックした際のメニューの画像】
 [RELATED_POSTS]

すると下記のようにストアドプログラム内で記載されたコメントがリストアップされます。

comment03.png

【コメントチェック画面の画像】

コメントを修正しよう

気に入らないコメントがあったらその部分でダブルクリック。すると・・・

comment04.png

↓↓↓ストアドプログラム「SAMPLE_FUNCTION」の39行にあるコメントへジャンプ↓↓↓

comment05.png

【コメントチェック画面にてダブルクリックした際の画面遷移の画像】
 

記載されているストアドプログラムの場所までジャンプできます。
これにより効率よく素早い修正が可能です。

いかがでしたか。今後、ストアドプログラムを管理する際に是非活用してみてください。
そして開発の方はくれぐれもネットスラング丸出しのコメントや愚痴っぽいコメントなどは残さないようお気をつけください。

いまさら聞けない Oracleの基本

RECENT POST「OBをトコトン極める」の最新記事


この記事が気に入ったらいいねしよう!