達人プログラマー第2版 8章 良い設計の本質について

Question

達人プログラマー第2版　8章で、良い設計の直感力を養うために下記の行動が推奨されていました。

• 日誌に設計の選択肢と前提を残すこと
• ソースにタグを残すこと
• 変更を変更する際に、過去を振り返ることでフィードバックを得ること

上記のうち、ソースにタグを残すことで具体的にどのようなタグを残せば良いのか想像がつきませんでした。
具体的にどのようなタグが想定されるか、教えていただきたいです。

Comments

[BeatStar]

そのページの後のページに載っていませんか？
パターン的には「後述」が多いです。

[fana]

そもそも「ソースにタグを残す」とは，どのような行為のことなのですか？

[dodox86]

今の質問内容では本書を読んだ回答者でないと、正確な回答は出来ない気がしますが、、、
タグは残せば良いってものじゃなくて、自分の為に残すのであろうから、何のために残すかを考えれば、何をタグに書けば良いか自分で判断できるのではないかな？　まぁ、習慣付けましょうということなのでしょうけど。

[yfm]

> そのページの後のページに載っていませんか？
章の最後まで読みましたが、記載はありませんでした。

> どのような行為のことなのですか？
「状況をエンジニアリング日誌に書き込み、選択肢と変更時の前提を残しておきましょう。ソースにタグを残しましょう。その後、このコードを変更する必要が生じた場合、見直す事ができ、フィードバックにすることが出来るはずです」と記載がありまして、具体的にどのような行為なのか私にはよく良くわかりません。

[dodox86]

[不要なコメントなので削除]

Answer 1

今の日本語でいうと「ハッシュタグ」に近い感じです。
後で検索するために使うキーワードなどを書き込んでおくことですね。

ソースコードから読みとれるものについては、GNU Globalなんかが自動的にやってくれますが、そうでないタグは自分で書き込んでおけよ、という意味だと思います。
目的とか、意味とか、制限事項とか、修正できていないバグとか、将来追加したいと思っている機能とか、そういうものをコメントなどを使って書き込んでおくと後で役に立つということです。

TaggingはIT関連では一般に使われる用語なので、The Pragmatic Programmerでは説明がないのでしょう。