Googleが公開している開発者向け英文スタイルガイドから項目を1つ取り上げて紹介します。スタイルガイドは基本的には書く際に利用されますが、読む際にも参考になります。

ボールドやイタリックを使う場面

URL： https://developers.google.com/style/text-formatting （2021-5-24閲覧）

今回は、ボールドやイタリックなどの書式をどの場面で使うかに関するガイドラインです。なお、英文サンプルはGoogleからの引用です。

ボールド（太字体）

HTMLでは「<b>」、マークダウン記法では「**」を使います。マークダウンは「__」（アンダースコア2つ）でも可能ですが、テキストエディターでは見分けが付きにくいという理由でアスタリスク2つ（**）が推奨されています。

次のように、ボールドはUI要素と注意書き冒頭で用います。

UI要素

• In the New Project window, select the New Activity checkbox, and then click Next.
  • UI要素である「New Project」（ウィンドウ名）、「New Activity」（チェックボックス名）、「Next」（恐らくボタン名）がボールド

注意書き冒頭

• Note: All VPC networks include firewall rules.
• Caution: After you delete a bucket, you can’t recover archived object versions.
• Warning: Do not manually edit or delete generated table entries.
  • 上記の「Note:」、「Caution」、「Warning:」がボールド

イタリック（斜体）

HTMLの場合は「<i>」、マークダウンの場合は「_」です。ただしHTMLでは「<em>」がイタリックで表示されるケースも多くあります。

次のように、イタリックは注目させたい語やタイトルなどで用います。

注目させたい語

何かしらの語やフレーズに注目させたいときに使います。たとえば用語の定義や、語そのものを示す際です。

• A Clos network is a kind of multistage circuit switching network, first formalized by Charles Clos in 1952.
  • 「Clos network」がイタリック。この言葉を定義している
• Don’t use & (ampersand) as a conjunction. Use the word and instead.
  • 最後から2語目の「and」がイタリック。andという語そのものを示してる

タイトル

書籍、映画、まとまったウェブ記事、その他ひとまとまりの作品などのタイトルに使います。ただしリンクが設定されている場合は除きます。

• …see The Chicago Manual of Style.
  • 「The Chicago Manual of Style」がイタリック

パラメーター名

関数やメソッドのパラメーターに使います。

• doSomething(Uri data, int count)
  • 「data」と「count」がイタリック

数学やバージョン番号での変数

• x + y = 3
  • 「x」と「y」がイタリック
• version 1.4.x
  • 「x」がイタリック

その他

下線は使わない

Googleスタイルガイドでは下線は使わないとしています。

コード用フォントを使う場面

文中でのコードやユーザー入力を示す場合、HTMLでは「<code>」、マークダウンでは「`」を使います。

またコード・サンプルなど、コードのブロックの場合、HTMLでは「<pre>」、マークダウンでは「“`」を使います。

コード用フォントを使う対象となるのは、クラス名、メソッド名、HTTPのステータス・コード、コンソールの出力、プレースホルダーの変数などです。例：

• To retrieve the zebra’s metadata, call its get() method.
  • メソッドの「get()」がコード用フォント
• an HTTP 400 Bad Request status code
  • HTTPのステータス・コード「HTTP 400 Bad Request」がコード用フォント

センテンス・ケースを使う

タイトルや見出しでは、最初の単語の1文字目だけを大文字にします。これは「センテンス・ケース」（sentence case）と呼ばれます。

たとえばGoogleスタイルガイドの紹介ページは「About this guide」という見出しになっています。これを「About This Guide」のようにしないという意味です。なお、このようにすべての単語（前置詞など一部を除く）の1文字目を大文字にする方法は「タイトル・ケース」（title case）と呼ばれます。

引用符はアメリカ式

引用符はアメリカ式を用います。詳しくは以前の記事を参照してください。

「&」をandの代わりに使わない

アンパサンド（&）は「and」の代用とせず、andはきちんと「and」と書きます。

ただし、UI要素やメニュー名を表記する場合は使っても問題ありません。

句読点はリンクに含めない

ピリオドなどの句読点は、リンクに含めません。

• ◯　For more information, see Test your code.
• ✕　For more information, see Test your code.
  • やや見にくいが下線がリンク部分

---

（ライセンス表示： Portions of this page are modifications based on work created and shared by Google and used according to terms described in the Creative Commons 4.0 Attribution License.）

---

[筆者紹介]