読者です 読者をやめる 読者になる 読者になる

コメントが欲しい

良くみなさんソースを見れば、わかるじゃんって平然と言いますが、確かにソースを見れば分かりますが、コメントが欲しいです。

自分が見てきて、やっぱりきれいなコードを書く人は、他人に優しいと思うですよね。

一度、慌てて色々とコメント書かずに、書いてしまうけど、関数(Function)のコメント等を書いて欲しいと思う今日この頃です。

コメントアウトに統一がないのは、すみません。

STARTとENDと分かるコメント


 addのSTARTとENDが分かるコメント
 --======== 2010/11/02, Added by K.Ando (START) ==========
 --======== 2010/11/02, Added by K.Ando (END) ============
 modのSTARTとENDが分かるコメント
 --======== 2010/11/02, mod by K.Ando (START) ==========
 --======== 2010/11/02, mod by K.Ando (END) ==========
 delのSTARTとENDが分かるコメント
 --======== 2010/11/02, del by K.Ando (START) ==========
 --======== 2010/11/02, del K.Ando (END) ==========

変数名が分かるコメント


emp_cd IN VARCHAR2 -- 1.社員コード
emp_name IN VARCHAR2 -- 2.社員名
RETURN BOOLEAN -- TRUE/FALSE (OK/NG)

BOOLEANのTRUEとFALSEの処理意味が欲しいです。TRUEなのに、処理失敗とかで使う場合もあると思うです。

プログラムの説明が分かるコメント


##########################################################################################
# ファイル名 : rsync.sh
# ファイル説明 : rsyncシェルスクリプト
# 用途 : バックアップ処理
# 変更履歴
# <バージョン> <変更日(YYYY/MM/DD)> <変更者> <変更内容>
# 1.0 2010/07/22 Ando 新規作成
# 1.1 2010/07/22 Ando rsyncでメモリー不足になるためディレクトリ単位変更
# 1.2 2010/07/22 Ando ディレクトリ単位のログ出力
# 1.3 2010/08/03 Ando ファイル分割
# 1.4 2010/08/05 Ando while read lineの読込ファイルの場所をフルパスに変更
##########################################################################################