ホーム > 結城浩の心がけ > 校正の実例2 | 検索 | 更新情報 |
文章を書く心がけ | 書き始めれば、書ける | 校正の実例 | 書籍執筆とオンラインレビュー | |
|
『Java言語で学ぶデザインパターン入門』校正中に登場した「修正前」「修正後」の例を以下に示します。 典型的なもののみに絞りました。 1冊の本を実際に校正するときには、 これらのような修正が数百個〜千個ほど行われます。
修正前
これらのメソッドをプログラミングしているとき、プログラマは…(略)…を意識しながらコーディングします。
修正後
これらのメソッドをプログラミングしているとき、プログラマは…(略)…を意識します。
解説
ここでは「プログラミング」と「コーディング」という単語が重なっているので、片方(プログラミング)のみに絞っています。
修正前
概念図をFig.2-7に示します。
修正後
この関係を表現した概念図をFig.2-7に示します。
解説
意味がはっきりしなかったので「この関係を表現した」という説明を補っています。
修正前
枠組みで囲まれたような文字列が表示されます。
修正後
枠で囲まれた文字列が表示されます。
解説
「枠組み」や「囲まれたような」という表現はここではあいまいすぎるので、 ずばり「枠」「囲まれた」と直接表現しました。
修正前
サブクラスは、スーパークラスからメソッドを継承して便利なだけではなく、スーパークラスで定義されている抽象メソッドを実装するという責任が生じているといってもいいでしょう。
修正後
サブクラスには、スーパークラスで宣言されている抽象メソッドを実装するという責任が生じているといってもいいでしょう。
解説
ねじれた文は書かないようにします。 長い文はねじれやすいので特に注意します。 言いたいことに焦点を絞って、文を短くします。
修正前
スーパークラスで多く記述すればサブクラスは楽になりますが…
修正後
スーパークラスでの記述を多くすれば、サブクラスでの記述を少なくできますが…
解説
「スーパークラス」と「サブクラス」を対比させ、 「多く」と「少なく」を対比させていることがはっきりとわかるようにします。 そのために、対比させる表現がパラレル(並行)になるようにします。
修正前
Template Methodパターンは、その間をとっています。
修正後
Template Methodパターンでは、処理の骨組みをスーパークラスで記述し、具体的な肉付けをサブクラスで行っています。
解説
「その間」というあいまいな表現をやめ、 「処理の骨組みを…」という具体的な表現に入れ替えています。
修正前
Factory Methodパターンでは、スーパークラスの側でインスタンス生成の方法およびどのような種類のインスタンスを作るかを定めます。しかし、生成するインスタンスの具体的なクラス名までは定めません。
修正後
Factory Methodパターンでは、インスタンスの作り方をスーパークラスの側で定めますが、具体的なクラス名までは定めません。
解説
正確に述べようとするあまり、長くて読みにくい文章を書いてしまう場合があります。 意味をはっきりさせるため、言葉をばっさり削ります。
修正前
内部的に手の強さを判定しているのは、fightというメソッドです。
修正後
このクラスの内部で実際に手の強さを判定しているのは、fightというメソッドです。
解説
「内部的」というよりも「このクラスの内部で」の方がはっきりします。
修正前
ここで文字列にthisを加えて(+して)いますが、このようにオブジェクトと文字列を加えると…
修正後
ここで、"/" + this という演算をしていますが、このように文字列とオブジェクトを加えると…
解説
「加えて(+して)」という回りくどい表現ではなく、 「"/" + thisという演算」と直接的に表現しています。 また、"/"は文字列でthisはオブジェクトなので、 「オブジェクトと文字列を加えると」ではなく 「文字列とオブジェクトを加えると」と順番を入れ替えています。
あなたのご意見・感想をお送りください。 あなたの一言が大きなはげみとなりますので、どんなことでもどうぞ。