コメントアウトしたコードが動作に影響する場面がある件について(マジックコメント)

コメントアウトしたコードが動作に影響する場面がある

【背景】

Swiftの環境構築の際や、Rubyで文字列を変換する為に文字コードを指定することがあった。
そこで、

# coding:UTF-8

# 以下各自のコードが続く

という記述があり、この
「# coding:UTF-8はコメントアウトされているから、書かなくてもいいよね」
と思ったのだが、そうはいかなかったことが発端ですと。

他にも、Swiftの環境構築で、SwiftPM（PackageManager）を導入する際、次の記述をファイルに書き込んだのだが、
1行目の
// swift-tools-version: 5.8
この記述が無いとビルドに失敗したりする。

// swift-tools-version: 5.8

import PackageDescription

let package = Package(
    name: "BuildTools",
    dependencies: [
        .package(url: "https://github.com/nicklockwood/SwiftFormat", exact: "0.51.11"),
        .package(url: "https://github.com/realm/SwiftLint", exact: "0.47.0")
    ],
    targets: [.target(name: "BuildTools", path: "")]
)

---

最後に

このように、コメントアウトされながらも意味を持つコードがあるということを知らなければ、エラーの原因を探る際にかなり遠回りをすることになるので、知っておくと良いかもね。