こんにちは
新人プログラマーの落合です
先日、プロ野球の日本シリーズでマリーンズが日本一となりました
それで普段ゲームのニュースを取り上げている会社のイントラネットのホームページに
“千葉ロッテマリーンズ優勝”
なんて出ていたものだから何事かと思って読んでみると
スポンサーが運営しているオンラインゲームの記念イベントを行うということでした
どれもプレイしていない・・・有名タイトルなんですけどね・・・
今日はプログラムのコメントに対するこだわりを書いていこうかなと思います
たかがコメントされどコメント
そこには様々な苦悩や喜び、妄想が含まれています
コメントというのはプログラム中に書き込む人間のためのメモと考えてください
コメントはプログラム中に自由に書き込むことができます
何故コメントがいるかというとプログラムはちょっと油断すると書いた人にも読めなくなってしまうものなのです
其の一.ファイルの概要編
前述したようにプログラムを書いて半年後にこのプログラムがどういうものかわからなくなってしまったら?
全くコメントが書かれていなかったら理解するのにちょっと苦労しそうです
そんなときファイルの先頭にある程度の情報があると嬉しい
作成者とか概要とか・・・
一般的にそんな情報をヘッダーと呼ぶとか呼ばないとか
//*************************************************** // File:platinum.cpp // Brief:プラチナの社員を表示するプログラム // Author:ぷらちな げーむず //***************************************************(83桁)
という具合に私は書いています
ちなみに*が書かれた行は83桁(文字数)で書くのが最近のお気に入りです
アスタリスクで行を挟むのがプラチナの社員でも多いです
コピペで既存のファイルから作成することが多いからかもしれません
学生時代は/だけで挟むこともしてました
気分によって変えてますが現在は固定しています
プラチナでは見ないですがPythonライクに#で挟んだりする人もいる・・・のかも
其の二.見出し
ファイルの概要だけでは情報として不十分なときが多いです
数千行とあるファイルで他に情報が無いときを想像すると身の毛がよだちます
そんなときに見出しを書きます
見出しと概要ってどう違うんだ・・・まぁ細かい事はいいか
見出しも人によって様々な思い入れがあるみたいです
其の一と同様にアスタリスクで挟む人、桁数を減らして書く人やインデントをつけてずらす人、同じ桁数の人様々です
//==================================== // 見出しA //==================================== //------------------------------------ // 見出しB //------------------------------------
私はこう書いていますがこれは会社に入って真似し始めたものです
同期のシモンはCライクに
/* * 見出し */
と書いています
同じく同期の曽我は
//~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ // 見出し //____________________________________
と書いているのを目撃しました
この辺りは個性が出て面白いですね
ちょっとした小さい事でも自分なりに楽しめるようになると
良い事が待っているかもしれないデスネ
最近は寒さが目立ってきたので
就職活動中に風邪をひかないよう注意してください
風邪予防
- うがい・手洗い
- バランスの良い食事
- 適度な温度と湿度を保つ
- 祈り
風邪ひいてしまったら
- 気合いで頑張る
予防が大事だってことですね・・・耳が痛いですが
*で囲むのは可愛らしくていいですね
読みやすいプログラムを書ける人は尊敬します…