Swift:理解//マーク


137

Swiftでコメントを書く目的は何ですか:

// MARK: This is a comment

あなたもできるとき:

// This is a comment

何を// MARK達成しますか?

回答:


251

// MARK:そして// MARK: -スウィフトでの構文に同一の機能#pragma mark#pragma mark -Objective-Cのシンタックス。

この構文(プラス// TODO:// FIXME:)を使用すると、いくつかの追加情報を取得して、クイックジャンプバーに表示できます。

次の数行のソースコードを考えてみます。

// MARK: A mark comment lives here.

func isPrime(_ value: UInt) -> Bool { return true }

ここに画像の説明を入力してください

参考までに、クイックジャンプバーはXcodeの上部にあります。

ここに画像の説明を入力してください

これは主に、ファイル内の迅速なナビゲーションを支援するために存在します。

ダッシュ(// MARK: -)により、適切な分離線が表示されることに注意してください。このMARKコメントを検討してください:

// MARK: - A mark comment lives here.

ここに画像の説明を入力してください

そのメニューの太字のオプションのすぐ上の濃い灰色の区切り線はダッシュから来ています。

さらに、ダッシュの後にテキストを入力しないことで、コメントなしでこの区切り線を実現できます。

// MARK: -

ここに画像の説明を入力してください

言及、// TODO:および// FIXME:コメントもここに表示されます。

// MARK: - Prime functions

func isPrime(_ value: UInt) -> Bool {
    // TODO: Actually implement the logic for this method
    return true
}

func nthPrime(_ value: UInt) -> Int {
    // FIXME: Returns incorrect values for some arguments
    return 2
}

ここに画像の説明を入力してください

  • FIXMEには、目立たせるのに役立つ小さなバンドエイドアイコンが表示されます。
  • マークアイコンは目次のように見えます
  • TODOアイコンはチェックリストのように見えます

クイックジャンプバーの任意の行をクリックすると、ソースコードのその行に直接移動します。


この機能はSwift / Objective-CまたはXcodeに固有のものですか?
ma11hew28

Xcode、おそらく。ただし、他のIDEが同様の動作を示す可能性があることは容易に想像できます。
nhgrif

あなたはまた、あなたのテキストの後にハイフンを置くことができる// MARK: /Delegate impl. -セクションの最後、またはなぜないの両方をマークするために、:// MARK: - Attention! -
アンドレアス


-5

いつでも使用できます

// MARK: - Properties
var name: String

// MARK: - Methods
func display() {
}

init(name: String, rollNumber: Int) {

    // TODO: add configuration code
    self.name = name
}

// FIXME: bug XYZ
func fixBug() {

}
弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.