プログラミング関連のドキュメントで頻出する英語表現を紹介します。とりわけAPIリファレンスやマニュアルでよく用いられる表現を取り上げます。

---

APIリファレンスやマニュアルでは、読者に別の情報を参照してもらうケースがよくあります。頻出表現の第1回では「詳細は◯◯を参照してください」という表現を紹介しました。

今回は同じく、別の情報を参照してもらいたい場合に使える「◯◯にあるとおり」という表現です。

▼ as described in …

これが最もよく見られる基本的な形です。describeは「記述する」や「説明する」という動詞です。「…」の部分に場所が示されます。例：

• As described in the previous section, you need to change your password.
  • 前のセクションにあるとおり、お使いのパスワードを変更する必要があります。
• Edit your profile as described in this documentation.
  • このドキュメントにあるとおりにプロフィールを編集します。

describe以外の動詞

describe以外の動詞を使うことで、表現に変化を付けたり、ニュアンスを変えたりできます。

define（定義する）、discuss（論じる）、explain（説明する）、show（見せる）、specifiy（指定する）といった動詞です。例：

• Returns a string as defined in RFC xxx.
  • RFC xxxに定義されているような文字列を返す。
• Add a README file as discussed in #154
  • #154で議論したとおりにREADMEファイルを追加（※コミットメッセージ）
• Specify a destination as explained in Step 3.
  • ステップ3で説明したとおりに宛先を指定します。
• An error dialog appears, as shown in Figure 5.
  • 図5で示すように、エラー・ダイアログが表示されます。
• [Parameters] attrs: Attributes as defined in XML file.
  • ［パラメーター］attrs：XMLファイルに定義されている属性。

in以外の前置詞や副詞

ほかの応用として、前置詞inの部分を別の言葉に置き換える方法もあります。

たとえばabove（上に、上記）、earlier（以前）、here（ここに）です。例：

• HTTPS should be used as described above.
  • 上記のとおりHTTPSを使うことが望ましい。
• As described earlier, user accounts cannot be deleted automatically.
  • 前述したように、ユーザー・アカウントは自動的に削除できません。
• Our services are as described here: www.example.com.
  • 弊社サービスはここに記載されているとおりとなります： www.example.com

---

[筆者紹介]