Bagaimana anda melakukan blok komentar di YAML?

YAML mendukung inline komentar, tetapi tidak mendukung blok komentar.

Dari Wikipedia:

Komentar diawali dengan tanda nomor ( # ), bisa mulai di mana saja pada baris, dan berlanjut sampai akhir baris

Perbandingan dengan JSON, juga dari Wikipedia:

sintaks perbedaan yang halus dan jarang muncul dalam praktek: JSON memungkinkan diperpanjang charactersets seperti UTF-32, YAML membutuhkan ruang setelah pemisah seperti koma, sama, dan usus besar sedangkan JSON tidak, dan beberapa non-standar implementasi JSON memperpanjang tata bahasa untuk memasukkan Javascript's /* ... */ komentar. Penanganan tersebut edge kasus mungkin memerlukan cahaya pra-pengolahan sebelum parsing JSON sebagai in-line YAML.

# If you want to write
# a block-commented Haiku
# you'll need three pound signs

The spec hanya menjelaskan salah satu cara menandai komentar:

eksplisit komentar ditandai dengan "#" indikator.

Yang's semua. Tidak ada blok komentar.

Tidak mencoba untuk menjadi pintar tentang hal itu, tetapi jika anda menggunakan Sublime Text untuk editor anda, langkah-langkahnya adalah:

1. Pilih blok
2. cmd+/ pada Mac atau pilih+/ Linux & Windows
3. Keuntungan

I'd membayangkan bahwa editor lain memiliki fungsi yang sama juga. Yang mana yang anda gunakan? I'd senang untuk melakukan penyelidikan.

Di Vim anda dapat melakukan salah satu dari berikut:

• Komentar semua lini: :%s/^/#
• Baris komentar 10 - 15: :10,15 s/^/#
• Baris komentar 10 untuk baris saat ini: :10,.s/^/#
• Baris komentar 10 berakhir: :10,$s/^/#

atau dengan menggunakan visual block:

1. Pilih beberapa baris kolom setelah memasuki visual blok melalui Ctrl+v.
2. Tekan r diikuti oleh # untuk komentar beberapa baris blok mengganti pilihan, atau Shift+i#Spasi untuk menyisipkan komentar karakter sebelum pemilihan.

Alternatif pendekatan:

Jika

• anda YAML struktur yang telah didefinisikan dengan baik bidang yang akan digunakan oleh aplikasi anda
• DAN anda dapat dengan bebas menambahkan kolom tambahan yang tidak't mengacaukan dengan aplikasi anda

kemudian

• pada setiap tingkat, anda dapat menambahkan baru blok teks field bernama seperti "Keterangan" atau "Komentar" atau "Catatan" atau apapun

Contoh:

Bukan

# This comment
# is too long

gunakan

Description: >
  This comment
  is too long

atau

Comment: >
    This comment is also too long
    and newlines survive from parsing!

Lebih banyak keuntungan:

1. Jika komentar menjadi besar dan kompleks dan memiliki pola yang berulang, anda dapat mempromosikan mereka dari plain text blok untuk benda-benda
2. Aplikasi anda dapat -di masa depan - baca atau memperbarui mereka komentar

Jika anda menggunakan Eclipse dengan yedit plugin (editor untuk .file yaml), anda dapat komentar-out beberapa baris dengan:

1. memilih baris untuk berkomentar, dan kemudian
2. Pilih + Shift + C

Dan untuk un-komentar, ikuti langkah yang sama.

Emacs memiliki komentar-dwim (Melakukan Apa yang saya Maksud) - hanya memilih blok dan melakukan:

M-;

It's toggle - menggunakannya untuk komentar DAN tanda blok.

Jika anda don't memiliki yaml-mode terinstal, anda akan perlu untuk memberitahu Emacs untuk menggunakan karakter hash (#).

Untuk Tambang Ruby pengguna pada Windows:

Membuka file dalam editor Pilih blok dan tekan Pilih+slash, anda akan memiliki blok yang dipilih dimulai dengan #.

Sekarang jika anda ingin un-komentar yang mengomentari blok, tekan kombinasi tombol yang sama Pilih+slash lagi

Untuk Kode Visual Studio (VSCode) pengguna, shortcut untuk komentar beberapa baris untuk menyorot baris anda ingin komentar dan kemudian tekan:

pilih + /

Menekan pilih + / lagi juga dapat digunakan untuk beralih comments off untuk satu atau lebih baris yang dipilih.

Salah satu cara untuk memblokir komentar di YAML adalah dengan menggunakan teks editor seperti Notepad++ untuk menambahkan # (komentar) tag ke beberapa baris sekaligus.

Di Notepad++ anda dapat melakukannya dengan menggunakan "Blok Komentar" klik kanan opsi untuk teks yang dipilih.