今までに色々なソースを作ってきました。
ソース毎にそのプログラムがいつ作られて
どんなプログラムかを一番上に書いております(看板)。
この看板なのですが正式な名称があるのでしょうか?
また書いている方にお聞きします。
どのような看板を書いているか張っていただけますと幸いです。
ソースコードの説明について
Re:ソースコードの説明について
連レスすみません。
ちなみに私のものです。
看板
/*//////////////////////////////////////////////////
機能名:
メモ:
作成日:2009/01/01 更新日:2009/01/01
/////////////////////////////////////////////////*/
/*//////////////////////////////////////////////////
機能名:
引数:x → 出力する数字 , y → モード
メモ:
作成日:2009/01/01 更新日:2009/01/01
/////////////////////////////////////////////////*/
void Func(int x,int mode){
~処理~
}
ちなみに私のものです。
看板
/*//////////////////////////////////////////////////
機能名:
メモ:
作成日:2009/01/01 更新日:2009/01/01
/////////////////////////////////////////////////*/
/*//////////////////////////////////////////////////
機能名:
引数:x → 出力する数字 , y → モード
メモ:
作成日:2009/01/01 更新日:2009/01/01
/////////////////////////////////////////////////*/
void Func(int x,int mode){
~処理~
}
Re:ソースコードの説明について
「コメント」って言うと思うよ^^
基本的に好きなこと書いていいらしいよ。
あると便利だけど、コメントの使いすぎは逆に見づらくなるし、
間違ったコメントはミスリードになるので、注意したほうがいいみたい。
プログラムの先頭に書く場合、そのプログラムを書いた人や
どんな目的のプログラムなのか、いつ書いたのかを書くことが多いんじゃないかな。
基本的に好きなこと書いていいらしいよ。
あると便利だけど、コメントの使いすぎは逆に見づらくなるし、
間違ったコメントはミスリードになるので、注意したほうがいいみたい。
プログラムの先頭に書く場合、そのプログラムを書いた人や
どんな目的のプログラムなのか、いつ書いたのかを書くことが多いんじゃないかな。