当ブログに掲載しているサンプルは、すべて利用者の自己責任という形でお願いします。
ただし、明らかな不具合がある場合、ご連絡いただければ、訂正記事を出します。
また、こちらのサンプルは、別のサイト等への公開、転載は一切禁止しています。
どうしてもと言う場合は、筆者にあらかじめご連絡ください。
記事そのもののリンクについてはご自由に行っていただいてよいです。

テクてく Lotus 技術者 Slack に参加しよう!

2014年2月17日月曜日

コメントのテンプレートを加工しよう!

皆さん、こんにちは。今年の日本は雪が多く大変ですね(まるで他人事・・・)。
今週の水曜日(2014年2月19日)は、テクてくLotus技術者夜会がありますが、その日の天気予報も「曇りのち一時雪」と、雪の予報になっています。
なんとか降らない事を祈るばかりです。


では、本日の話題に行く前に、久しぶりのボタンクリックをしましょう。
にほんブログ村 IT技術ブログへ


IBM Connect 2014のうち、Domino Designerの便利な使い方について紹介していたセッションに参加したのですが、残念ながら当ブログでも紹介していたものが多かったのでした。紹介していた内容が世界にも通じている!という意味では嬉しいのですが、新しいことを知ることができなかった(あったのかもしれませんが、全部は理解できませんでした・・・)のは残念でした。

ということで、Domino Designerのプリファレンスを眺めていて、便利そうだな。という機能について追加で紹介を行います。


さて、それでは本題です。
今回はDomino Designerのうち、「コメントのテンプレート」について紹介します。

LotusScript を記述していると、多くのSub関数やFunction関数を作成することになるかと思います。
その時に、それらの関数の説明を入力しておくこともあるかと思います(書いておかないと、後々メンテナンスする時に大変なことになりますよね)。


Domino Designerは、関数を作成すると、先頭にその関数に関するコメントを自動で付加してくれます(下図)。しかし、コメントが英語になっている事や情報量が少ないという事から自分でその都度、修正しているという方も少なくないのではないでしょうか。
デフォルトのコメント

このコメントはテンプレートとしてDomino Designerの中に組み込まれているものです。
そして、この内容は変更することが可能なのです。

変更する方法は次の通りです。
[ファイル][プリファレンス]メニューを実行して、Domino Designerのプリファレンス画面を開きます。
その中で[Domino Designer][LotusScript エディタ][コメントのテンプレート]を開くと、コメントのテンプレートを設定する画面に切り替わります(下図)。
コメントのテンプレート画面

右側上部にある「コード要素」を選択すると、右側下部にそのコメントのテンプレートが表示されます。
そのコメントのテンプレートを修正して、[適用]ボタンをクリックすれば、良いのです。

下図はFunction関数のコメントテンプレートを修正した後にFunction関数を作成した結果です。
確かにコメントが反映されています。日本語も使えるのは良いですね。
Function関数のコメントテンプレートを加工したもの

どうでしょうか?これで今まで手入力もしくは他のコードからコピー&ペーストしていた作業がなくなるのではないでしょうか?

コメントは書きすぎても分かりにくくなりますが、まったく書いてないと、後で見なおした時に解読不能になってしまいかねません。
この機能を利用して、良いコメントを残すようにしましょう。


では、今日はこの辺で。






【PR】ノーツ/ドミノに関するお問い合わせは下記まで【PR】
単純なDBのカスタマイズから他アプリケーションとの連携までご要望にお応えします!
Lotus Notes/Domino カスタマイズとセキュリティ強化 - 株式会社エフ

2 件のコメント:

Katoman さんのコメント...

Eclipse に乗っかってからまだまだ知らないことが多いような気がします。これからもよろしく。

Masahiko Miyo さんのコメント...

Katomanさん、コメントありがとうございます。
確かにEclipseベースになってから機能が増えました(増えすぎ?)。
XPages関連の機能もいくつかあるので、徐々に紹介していけるようにします。