« 今回は・・・ | トップページ | 羽賀研二たじたじでしたね »

2004.01.31

プログラムコードのコメント

これってちゃんと日頃からつけること習慣付けておけばなんら問題の無いことですが、人と共同作業でないときは結構付け忘れます。さらに外国人の書いたコードを借りてくるときはコメントが英語になってたりします。

さらにコメントというのは、他人に見てもらうもの(自分が忘れてしまったときのためもあるが)なんで原則的には読みやすくなってる必要性があるわけですが、まぁこういうときは大抵はドキュメント自動生成ツールの記法を採用することにしています。このドキュメント自動生成ツールも色々ありますが、私はDoxygenを使っております。他のツールは良く知りません。知っているものではJavaにはJavadocツール、Visual StudioにもなんかそれらしいものがありますがDoxygenが慣れちゃいました(Visual Studioのはちょこっと使ってみたんですがなんか閲覧性が好みではなかった)。

まぁ、ドキュメント作成はこれでいいんですが問題はバージョン管理ですね。CVSを導入するするいってなかなか出来てません。Visual Source Safeの購入も提案してもいいんですがアカデミックが無いので高いんでちょっと言いにくいですね、使う人がすくないと。そうなるとやはり自分でCVSの使い方を覚えた方が安いですしねぇ(CVSの導入に手間取るのはやはりWindowsに慣れすぎてコマンドラインに慣れないこととGUIのWinCVSではローカライズせず使おうとして英語のリファレンスを読まなかったことかな?)。

« 今回は・・・ | トップページ | 羽賀研二たじたじでしたね »

Programming」カテゴリの記事

コメント

コメントを書く

(ウェブ上には掲載しません)

トラックバック


この記事へのトラックバック一覧です: プログラムコードのコメント:

« 今回は・・・ | トップページ | 羽賀研二たじたじでしたね »