Swift ソースコードへの注釈の追加
あなたの Swift コードに注釈を付けて、Xcode でジャンプバーのポップアップメニューに有用な情報を追加します。
単一行コメントまたはコメントブロック内のいずれか一つだけ注釈を入れ、Swift コード内の注釈を挿入します。コメント行の任意の場所に注釈を入れます。最初の文字列である必要はありません。単一行コメントでは、2つのスラッシュ // で注釈を開始します。
to-do 項目を追加するには、todo 注釈を使用します。 todo 注釈は、文字列 TODO を挿入し、ポップアップメニューで、太字で、その単語を加えた一行のテキストが表示されます。
// TODO: コンテンツ
セクションに見出しを追加するには、マークの注釈を使用します。 マークの注釈は、ポップアップメニューで、太字で、単一の行にあなたの見出しが表示されます。
// MARK: 見出し
バグ修正リマインダーを追加するには、fixme 構文を使用します。 fixme 注釈は、文字列 FIXME: を挿入し、ポップアップメニューで、太字で、その単語を加えた一行のリマインダーを表示します。
// FIXME: コンテンツ
区切り線を追加するには、以下のいずれかの操作を行います:
- あなたのコンテンツの上に区切りを追加するには、マークのコンテンツ文字列の 前に ハイフンを追加します。
- あなたのコンテンツの下に区切りを追加するには、マークのコンテンツ文字列の 後に ハイフンを追加します。
たとえば、この記事の開始の所のスクリーンショットでは、以下の注釈は区切り線に続く見出しを作成するために使用されました。