Sponsored Links
こんにちは!Lenocoです。本日も見てくださりありがとうございます。
今回はプロシージャのヘッダコメントについてです!!!
Sponsored Links
Contents
プロシージャのヘッダコメント
作成したプロシージャの説明、みなさん書いていますか?
1行でパパっとコメントを入れている方もいるかと思います。
私も、忙しいときや、自分用のマクロだったりすると、つい簡単に済ませてしまっていました。
ですが、できればこんな形で丁寧にメモを残したい・・!と思い、
実践するようにしています。
ヘッダコメントの内容
どうでしょう、結構見やすいかなと自分では思っていますが 笑
「Name」:プロシージャ名
「Details」:プロシージャの説明
「Parameter」:引数の説明
「Return」:戻り値の説明
「Details」:プロシージャの説明
「Parameter」:引数の説明
「Return」:戻り値の説明
※プロシージャによっては引数や戻り値が無い場合もあります。
このヘッダコメントを入れておくだけで、
このプロシージャはどんな引数を使い、
どんな処理をして、
どんな値を戻すのか
がすぐに分かるかと思います。
さいごに
他の人が見たときにも、未来の自分が見たときにも
役に立つと思うので、入れておいて損はないかなと思います!
Lenoco
Sponsored Links