1年前の僕にはもう2度と会えない
ソースコードにはちゃんとコメントつけましょうね、ってお話。
久しぶりに目次スクリプト見てみたのですが、作った本人にも何がどうなっているのかよくわかりません(苦笑)。
もとが思いつきで作ったスクリプトで、継ぎ足しを繰り返したこともあり、すっかりスパゲッティになっているということもありますが……。
個人的には、あまりに冗長にコメントが付いているとかえって見難いので、関数や変数等の名前をそれっぽくして(機能に関連した名称を用いることで)、コメントは最小限におさえる、という方針を好むのですが……その最小限のコメントすらついていないと、こうなるという悪い見本です。
ある程度の長さを持ったソースコード書くなら、適度なコメントを入れるようにしないといけませんなぁ、と改めて感じたしだい。
他人に見られることを前提にする場合はもちろん、未来の自分も結構別人なので。
1年前、どころか、1日前でもあやしいことも……これは日記(ブログ)とかを書く場合にも言えるか、な?
もとが思いつきで作ったスクリプトで、継ぎ足しを繰り返したこともあり、すっかりスパゲッティになっているということもありますが……。
個人的には、あまりに冗長にコメントが付いているとかえって見難いので、関数や変数等の名前をそれっぽくして(機能に関連した名称を用いることで)、コメントは最小限におさえる、という方針を好むのですが……その最小限のコメントすらついていないと、こうなるという悪い見本です。
ある程度の長さを持ったソースコード書くなら、適度なコメントを入れるようにしないといけませんなぁ、と改めて感じたしだい。
他人に見られることを前提にする場合はもちろん、未来の自分も結構別人なので。
1年前、どころか、1日前でもあやしいことも……これは日記(ブログ)とかを書く場合にも言えるか、な?
でも、わかっちゃいるけど、なかなか実行できないんですよねぇ(苦笑)
■BGM
槇原敬之
『Home Sweet Home』
|
« 【ココログ】目次スクリプトを改修 | トップページ | 【ココログ】コメント展開表示ボタンを付けるスクリプト »
「ひとりごと」カテゴリの記事
- 久しぶりの投稿がココログへの苦言というのもなんなのですが……(2019.03.20)
- 鍛高譚 ~ カレイにまつわる物語(2018.05.25)
- 神使の兎 ~宇治神社にて~(2016.07.10)
- スマートフォンをPC上の音楽を再生するためのリモコンとして使いたい(2016.01.10)
- BIGLOBE光ネクスト(大阪)の通信速度問題 - プロバイダ選びは難しい……(2015.08.13)
コメント