最終更新時刻:2008年7月24日(木) 12時52分

5

コメント記法の効果

公開日時:
2008/05/21 22:54
著者:
名夢子

C言語研修で、嫌と言うほど、コメントを書け、こう書くんだ!と言い続けた結果、コメントがプログラムの骨組みの支えを作っていることが、体感できたようで、全員がコメントから書いてみるようになった。日本語がおぼつかない者もいるのだが、まぁ、そこはよしとして、プログラム設計の一歩を踏み出すことが出来た。

そうなってみると、今度は、戦術的なコメントの書法だ。著作権、プログラム説明、処理説明、各宣言の解説、デバッグ中のコード、アルゴリズムの説明などなど、プログラムコード中に説明しなければならないことは、ごまんとある。具体的にはプロジェクト毎に書き方が決定されるため、研修ではこれまでの経験から共通項を抜き出したものを伝える。しかし、これをまとめたところかなりの分量になった。「コメント書法」なる本でも書けそうだ。

効果的なコメントの書き方を一方的に伝授した形になってしまったが、一部の情報系出身者には喜ばれたので、よしとしたい。うれしいことに現在行っている参照型言語の研修では、いち早く「コメントはどうやって書くのですか」という質問が飛び交っている。そのせいなのか、言語習得力がぐんぐんとアップしているようにも感じる。この調子でいくと、発見的帰納的な学習は早めに終了して、演繹的なものへと進めても大丈夫だろう。しかし、ついてこれない者がいないとも限らない... 教育の難しさは、意外とうまくいっているときに、落ちこぼれていく者を事前に察知できるかどうかなのか、といまさらながら思うのだった。

※このエントリは CNET Japan ブロガーにより投稿されたものです。シーネットネットワークスジャパン および CNET Japan 編集部の見解・意向を示すものではありません。

このエントリーへのコメント

4

みなさん、コメントありがとうございます。
>hokkyさん、きむこうさん、kirifueさん

 私の会社では実際のコメント記述はプロジェクト毎のコーディネーション・プロシージャで決定されているので、それに従います。英語できちんと記述されているものもあれば、コメントは一切無く、プログラム設計書で十分に表現する。時には、変数名、関数名なども意味を持たせない表記になっていたりします。
 こういった現場での対応は、応用にあたると判断して、基本的な「しつけ」を新入社員にしています。Doxvgenを使っている部署もありますが、これがまだ全社標準的に使われていないので、研修に組み込むのは見送りました。来年以降はアセンブラとJavaの言語研修に切り替えようかとも思っているのですが、C言語のような発見的な教育効果が得られるかどうか、若干疑問なので、その点も検討しながら、来年度の教育プランを練っていきたいと思っています。

  名夢子 on 2008/05/25

3

C言語、懐かしいです。cgiですら、C言語を使ってましたっけ。メモリリークにはよく悩まされました…。
慣れてくるとコメントより先にコードを打ち込んでしまいがちですが、新人君にはコメントから記述させることが効果的なんですね。なるほど。
また、hokkyさんがおっしゃるように「Doxygen」を利用すると効率的ですが、そういうツールを利用するかは約束事なので、名夢子さんの会社ではいかがでしょうか。
個人的にはコメントをさぼっていると、後で自分でも分からなくなることがよくあるので、必要なことは必要となる箇所に記述することを心がけてます。てゆーか「コメントが必要なコードは書くな」って言われそう?!
海外の方と仕事をするときは仕方なく英語で書いてますが、これも時と場合と約束事によりますよね。

  kirifue on 2008/05/23

2

今の現場は逆に、
* コメントは書かない
* コメントが必要なコードは書くな
という方針です。

コメント無いとどうもぱっと見わからなくなることが結構ありますね

  きむこう on 2008/05/22

1

最近、ソフトウエアの開発は海外のチームとの共同開発が多くなってきているし、今後も増えていくでしょうから、コメントは日本語ではなく、英語で書いた方が良い様な気がしますが、どうなのでしょうね?まあ、研修だから日本語なのかもしれませんが。

あと、Doxygen (Javadoc)のようなものは導入していないのでしょうか?せっかく研修なので、そういうツールを使ったコメントの書き方も教えた方が良いんじゃないかなぁとちょっと思ってしまいました。

  hokky (cafe noir) on 2008/05/22

ブログにコメントするにはCNET_IDにログインしてください。

この記事に対するTrackBackのURL: 

このブログについて

ブロガープロフィール

アーカイブ

2008年7月
  12345
6789101112
13141516171819
20212223242526
2728293031  

カテゴリ

ブログネットワーク

アルファブロガー

外資系エグゼクティブの日々今アーキテクチャが面白い
外資系エグゼクティブの日々
クロサカタツヤの情報通信インサイトインターネットのリュミエール
クロサカタツヤの情報通信インサイト
平野敦士カールのアライアンスInsightGoogleお前もか?
平野敦士カールのアライアンスInsight
江島健太郎 / Kenn's ClairvoyanceiPhoneという奇跡
江島健太郎 / Kenn's Clairvoyance
末吉隆彦 ロケーションウェアの「空」と「実」サミット、サミット、そして今こそ!公衆無線LAN
末吉隆彦 ロケーションウェアの「空」と「実」
佐々木俊尚 ジャーナリストの視点暗黙共同体へ−秋葉原事件で考える
佐々木俊尚 ジャーナリストの視点

読者ブロガー

レンタルサーバの裏事情サーバトラブル事例(2)
レンタルサーバの裏事情
朝之丞のTry and TestedGoogle Lively試してみました。
朝之丞のTry and Tested

企画特集

DELLが掲げる「新・仮想化アセスメントサービス」DELLが掲げる「新・仮想化アセスメントサービス」
〜企業システムの仮想化環境の構築を支援〜

新着コメント

EMONEαもiPhoneも所有しておりますが、どちらをより使いたい、携帯したいかと......
iPhoneの「絶賛」と「冷めた反応」の間で
投稿者:Toyolina
lifehacxさん、こんにちは。 CNETの方からTB pingが打てませんでしたので、......
Google Lively試してみました。
投稿者:朝之丞
統計などは別として,私の周りでも,私も含め,「最近ニコ動は面白くないから......
ニコ動、頭打ちなのかい
投稿者:さぁや
余計なことですが、ロータスヨーロッパは、当時のスーパーカーのレギュレーシ......
they'll drink from the fountain of retro,
投稿者:ルート134
1995年ですか、地震で高速道路は落ちるは、Windows95が発売されるは、サリン......
いつか見た歴史のひとコマ
投稿者:ルート134

ブログネットワークとは?

CNET Japan ブログネットワークは、元はCNET Japanの一読者であった読者ブロガーと、編集部の依頼により執筆されているアルファブロガーたちが、ブログを通じてオンタイムに批評や意見を発信する場である「オピニオンプレイス」、また、オピニオンを交換するブロガーたちが集うソサエティです。

広い視野と鋭い目を持ったブロガーたちが、今日のIT業界や製品に対するビジョンや見解について日々熱く語っています。

あなたもブログを書いてみませんか?

CNET Japanやその他サイトが提供するITニュースやコンテンツへの意見や分析、 ビジネスやテクノロジーに対するビジョンや見解について語っていただける方を 募集しています。ご応募はこちらから

ブログの投稿・管理

ブログの投稿はこちらから(※ブロガー専用)

ブログアワード2007開催決定!

今年最も活躍したブロガーを表彰します。詳細はこちらから

αマークって?

これは、CNET Japan 編集部の依頼に基づいて執筆されているCNET Japan アルファブロガーによるブログの印です。

Good!って?

CNET Japan ブログネットワーク内で拍手の代わりに使用する機能です。ブログを読んで、感激した・役に立ったなど、うれしいと思ったときにクリックしてください。多くGood!を獲得した記事は、より多くの人に読まれるように表示されます。

レビュー

[レビュー]高い信頼性を普通に使う地球に優しい電源ユニット--Antec EarthWattsシリーズ EA-650
“自作ユーザーは、電源ユニットに何を求めるのか?”出力なのか、安定性なのか、それとも機能性なのか?難し
オンリーワンの個性を極めた超薄型テレビ--日立 Wooo UTシリーズ
日立製作所の超薄型液晶テレビWooo UT 770シリーズは2008年6月にラインアップが増強され、さらに日立らしい
[レビュー]“この手があったか”と思わせるパワーユーザーも納得のPCオンデマンド--「VALUESTAR G タイプR Luiモデル」+「Lui RN」詳細レビュー
「VALUESTAR GタイプR Luiモデル+PCリモーター」は、設置場所にとらわれずにPCを使える、NECが新しく提案
[レビュー]テレビを持ち歩ける最強ツール--ソニー、Blu-rayレコーダー「BDZ-A70」
加速度的に製品の認知度を普及させているBlu-rayレコーダー。その高画質、長時間録画という製品特性に「お
今週の新製品総チェック:ソニー「VAIO」が新キーワードを発表、ビクターからはYouTube対応ビデオカメラ
[レビュー]ネットワーク対応の高機能デジタルフォトフレーム--ソニー「Canvas Online CP1」
15時間の行列で手に入れたiPhone 3Gファーストインプレッション--ソフトバンクモバイル「iPhone 3G」
今週の新製品総チェック:まさにiPhone一色の1週間、ついに店頭発売へ
北京を見逃すな!--2008年夏、今買うべき「薄型テレビ」