せぶん#coding #sourcereading #comment
作業タグ
将来ソースから関連する実装を見つけるための仕組み
これがあることでメンテ時間が短縮できている
#tag #sourcereading #comment
将来、関連処理を読みたい場合に備えて「タグ」をコメントにつけるようにし始めた
「5年前に実装したXXXの実装」
それをソースだけからgrep検索できるように
5年前だと、VCSのチェックインを探す手間が大きい
一方でソースgrepだと1分くらいで関連する情報に目を通せる
検索ノイズが高くないタグを考える時間はかかるが、「みらいの時間」を減らさないためには大切なこと
タグを考える時間もどんどん早くはなるだろう
#cppbuilder #sourcereading
名前でFindComponent()してからプロパティをget/setする実装
可読性が悪い
任意のプロパティ指定でget/setできるような関数を作れればいいけど
#sourcereading #tag #search
コメントにタグをつけることにより、将来の実装変更時のメンテが短時間で済む
今のところは一つの個別タグだけにしている
複合タグや階層タグは不使用
今日の実装では複合タグにすると良さそうな事例は出てきたな
#coding #sourcereading #comment
A. 記載しない
B. コメントで「それをしない」理由を記載する
=>
B
#coding #sourcereading
プログラマが知るべき97のこと by Kevlin Henney 2011-06-24
ボーイスカウト・ルール by Robert C. Martin
>ロバート・スティーブンソン「自分が最初に見た時よりも、世界を良い場所にすべく努力をしよう」
> チェックイン前にどこか１カ所でいいので改善しましょう。変数名をより適切なものに変えたり、大きい関数を２つの小さくよりシンプルな関数に分割する、というのでもいいのです。循環参照を解消するというのでもいいですし、インターフェイスを追加することでポリシーと実装を切り離すというのでもいいでしょう。
----
検索ノイズが大きそうな時に実施している
> 「どういう理由でこういうコードを書いたのか説明してくれ」と言われても文句は言えないとしたら。そう考えれば、自然に、そんな問い合わせを受けないですむようにしたい、と思うでしょう。そのために、技術力を少しずつでも高めようとし、変数名やメソッド名の付け方にも注意するようになります。
コードは生涯サポートするつもりで書く by Yuriy Zubarev
プログラマが知るべき97のこと by Kevlin Henney 2011-06-24
#coding #refactor #sourcereading
山登りコーディング
製品が安定して、古いハーケンがソースコードリーディングの邪魔になった頃に
ハーケンをはずす
#coding #sourcereading
コードは書くよりも読むことのほうがずっと多い
可読性の高いコードをきちんと書くこと
それを守らないな