プログラムコメントとは、プログラムに書かれている注釈である。
/* 概要 */
/*----------------------------------------------------------------------------
xxxx/xx/xx:初版作成
概要文を記載してください。後は任せた。
xxxx/xx/##:追記しました (外注:%PROGRAMER%)
プログラムコメントとは、この記事のようにプログラム内部に記述され
プログラムの実行とは全く関係のない文章であり、使用用途としてはその処理の内容および返り値などを記述して
プログラマー本人および本人以外の開発スタッフに対して、何をしているかを明確に示す事が目的で
プロジェクトによっては解りやすく記述してあったりこの記事のように酷いことになっている物もある
歴史を重ねたプログラムや、頻繁に変更されるようなプログラムの場合この部分が仕様書の最後の砦となりうる場合がある
xxxx/xx/##-2:追記しました (外注:%PROGRAMER-2%)
なお、上では全く関係の無い文書と記されていますが、一部のデータベースソフトなどにおいてはコメント部分に特殊なコメントを入れることによって実行の手続きを変更する命令句となり得る場合もあります
xxxx/xx/&&-3:雑談 (下請:%UNDER-PROGRAMER-1%):初版がひどい件に関して。小一時間問い詰めたい
xxxx/xx/&&-4:雑談 (下請:%UNDER-PROGRAMER-2%):発注元と思われ
xxxx/xx/&&-5:雑談 (下請:%UNDER-PROGRAMER-3%):外注%PROGRAMER%さん最近姿見ないんですよね…
----------------------------------------------------------------------------*/
int gaiyou()
{
char chrcomment[1024];
// 一行コメントの場合該当箇所の上に記述される場合もある
printf("いつになったらこのプロジェクトは終わるんだ!\n");
}
'/* 関連動画 */
'/*=================================================
'関連動画があればここに記述します
'引数は、smilevideoのIDです。
'=================================================*/
Private Sub NicoVideoPaste(byval StrNicovideoID as string)
'-- 動画が来たら、ここに関連動画をはる
'/* ↑ すいません、動画が無いんですが…*/
'// あー解った解った追加しておく
'-- ↑↑ 自分で探せやゴルァ
Dim 文字型動画格納変数 as string
Dim 文字型動画格納変数2 as string
'// うぎゃぁ誰だ!プログラムに全角文字使ったのは!
'/* ○○部長ですよ、外注安いからって頼んだらしいですよ? */
/* 関連商品 */
/*=================================================
*関連商品を追加します
*引数は、smilevideoのIDです。
*xxxx/xx/xx 追記:騙された!amazonのIDの間違いだろ。ソースコピペしやがったな!
*=================================================*/
/*
* 追伸:××長へ、市場に関連があったので記述しておきます。
* あと、先方の▼▲部長が飲み会のお金返してくださいって言ってましたよ?
* 対応:××君へ、お金は君がバグチェック作業している間に返却済みです。
* 雑用:@@@さん、サーバの容量がおっぱいです何とかしてください
* 雑用:↑ ---様、有給とって休んでください
*/
void nicoichiba(str nicoichibaid ) {
str strconvamazonid;
strconvamazonid="az" +nicoichibaid;
}
::関連記事
REM +++++++++++++++++++++++++++++++++++++++
REM +関連記事です
REM +他の記事への案内を行います
REM +++++++++++++++++++++++++++++++++++++++
ECHO OFF
ECHO ● プログラム
ECHO ● プログラミング
ECHO ● C言語
ECHO ● JAVA
ECHO ● VISUALBASIC
ECHO ● HTML
注意事項
実際の開発現場においては散見される可能性が非常に高いが全く関係のないコメントを仕込むのは現在では非推奨どころか禁止レベルである。
また、テキスト装飾を行う区切り記号についても無駄な情報量としてソースコードを肥え太らせてしまうため同様である。
プログラミングを学んだ諸兄がコメントを残す際は簡潔明瞭にすることを強く念を押させていただく。
- 3
- 0pt