コメントの書き方について

Question

就職作品用のソースコードのコメントを書く際に、requireって日本語でなんて書くといいんでしょうか・・・
長らくＣ＋＋に触れていたため、「ヘッダーのインクルード」って書いてたんですけれど、ふと思うと全然違うじゃんってなったため気になりました。
しっくりくる例を挙げて下さるとうれしいです。

Answer 1

ヘッダーのインクルードとは違いますね。

それと、そういうコメントを付けている例を見たことが無いので、
つけるのは推奨しないけど敢えてつける、という前提で。

Perlの場合は、v5以降はuseになっていますから、直訳で「～モジュールを使用」。
ただし、requireの場合も、やりたいことはライブラリーモジュールを使用することなので、同じで良いかと。

もしくは「～モジュールをインポート」とか。

目的に合わせるなら、「AモジュールとBモジュールを使用する」と1行だけ付ければ良いと思います。

Answer 2

私も require 文にコメントを書くことはほとんどしません。
ただし、require に書く名前と gem での名前が一致しないケースがある場合に、

require "active_record"   # gem install activerecord 

のように書くことがあります。

　　”ヘッダーのインクルード"
というコメントは 情報量がほぼゼロ なので書く事の意義はすくないとおもいます。

Answer 3

後出しで失礼致します。
requireやimport文にコメントってあんまり見ないですね。。。

重要なコメントとしては
・作成したクラス、メソッドが何を処理しているか
・引数、return値は何で何のオブジェクト又は型なのか
だと思います。

C++ならDoxygenというドキュメント生成ツールが主流なんですね。自分はC++専門ではないので詳しくわないですが。。。
JavaならJavaDoc、RubyならRDoc/Yard、PHPならPHPDoc等言語ごとにドキュメント生成ツールが存在するので各ツールに準じてコメントを記載すると綺麗なコメントになっていくと思いますよ

Answer 4

なるほど！
インポートがありましたか・・・！
とてもしっくりきました。
ありがとうございます！