XMLコメントの書き方 ( No.44 )
日時: 2022/03/27 12:31
名前: REDCHEEKS

今回はオブジェクト指向の話を離れ、コメントの話をしよう。

そもそもコメントとは何か、それはプログラムを見る人間のための説明書きなんだ。
だからコンピュータの動作には影響しない。
極論すれば、コメントが間違っていても、プログラムが正しければ、コンピュータはちゃんと動作するし、逆にいくらコメントが正しくても、プログラムが間違っていれば、誤動作する。
ではなんのためのコメントかというと、あくまでも人間のための覚え書きなんだ。

コメントの書き方は、プログラム言語によって異なるが、CやCから進化した、Java や C# では、// と2個並べることで、それ以降はコメントと見なしてコンピュータは関知しないというルールになっている。
コメントは、Visual Studio では、緑色に色分け表示され、わかりやすく表示されている。
Visual Studio(ビジュアル スタジオ)は、自動的に色分けしてくれて、わかりやすいだろ、さすがビルゲイツ、IT業界の「ビジュアル系」だ。

さて、// と2個並べるのは、普通のコメントだが、ビジュアルスタジオには、さらに次元を超えた、強力なコメント機能が存在する。
さらにスラッシュを3個並べることで、発現するその機能、それがXMLコメントなんだな。

というわけで、その次元を超えた強力なコメント機能について、今回も次元を超えたドエッチな説明始めるよ。

http://mediasp.kir.jp/img20220326/imgloglog-box/img20211118234247.png

@ 性器クラスの しこしこ() の上の行の 感度; の右をマウスでクリックし、カーソルをそこに置く。
A Enter(Return)キーを押下すると、改行され、空白の行が生まれる。
B そこに、スラッシュを3個入力した途端、
C <summary> と表示され、コメント入力可能な状態となる。
D コメント(しこしこ機能の説明)を入力する。

これで、XMLコメントが作成されたわけだ。
では、次にXMLコメントが表示されるのを確認しよう。

E 陰茎クラスのオーバーライドされた しこしこ() 内の、base.しこしこ() にマウスカーソルを持って行くと、先ほど入力したコメントが表示される。

これでどんなに恥ずかしい機能も、一目瞭然、露わになるのだ。
では次に、陰茎クラスのオーバーライドされた しこしこ() にも同様のコメントを書いてみよう。

F @〜D と同様に、どぴゅ〜機能も含めて、説明書きを加える。

これで、XMLコメントがさらに作成されたわけだ。
ではこの恥ずかしいコメントの表示を確認しよう。

G 男クラスの おなに() 機能内の、ちんちん.しこしこ() にマウスカーソルを持って行くと、先ほど入力した、たまらん恥ずかしいコメントが表示される。

練習問題(XMLコメント) ( No.45 )
日時: 2021/11/20 23:50
名前: REDCHEEKS

コメントを書き、プログラムをわかりやすくすることは、システム開発にとって重要です。

(1) これまで男側で説明してきましたが、同様に女側にもコメントを書きましょう。

(2) ぺんぺん() や おしおき() や おなに() などにもどんどんコメントを書いて行き、たまらん恥ずかしいシステムを構築しましょう。