Pertanyaan Bagaimana Anda memblokir komentar di yaml?


Apakah ada yang tahu cara mengomentari blok garis di yaml?


953
2018-02-16 21:42


asal


Jawaban:


YAML mendukung komentar inline, tetapi tidak mendukung komentar blok.

Dari Wikipedia:

Komentar dimulai dengan tanda angka ( # ), dapat mulai di mana saja pada garis, dan berlanjut hingga akhir baris

Perbandingan dengan JSON, juga dari Wikipedia:

Perbedaan sintaks yang halus dan jarang muncul dalam praktek: JSON memungkinkan karakter tambahan seperti UTF-32, YAML membutuhkan spasi setelah pemisah seperti koma, sama, dan titik dua sementara JSON tidak, dan beberapa implementasi JSON non-standar memperluas tata bahasa ke termasuk Javascript /* ... */ komentar. Menangani kasus-kasus tepi seperti itu mungkin memerlukan pra-pemrosesan ringan JSON sebelum mengurai seperti YAML.

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

1455
2018-02-16 21:47



Itu spesifikasi hanya menjelaskan satu cara menandai komentar:

Komentar eksplisit ditandai dengan indikator "#".

Itu saja. Tidak ada komentar blok.


146
2018-02-16 21:52



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

  1. Pilih blok
  2. CMD + / di Mac atau CTRL + / di Linux & Windows
  3. Keuntungan

Saya membayangkan bahwa editor lain juga memiliki fungsi yang serupa. Yang mana yang kamu gunakan? Saya akan senang melakukan penggalian.


82
2018-05-22 18:20



Di Vim Anda dapat melakukan salah satu dari yang berikut:

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

atau menggunakan blok visual:

  1. Pilih kolom multi-baris setelah memasukkan blok visual melalui Ctrl + v.
  2. tekan r diikuti oleh # untuk mengomentari blok multi-baris menggantikan pilihan, atau Shift + i#ESC untuk memasukkan karakter komentar sebelum pemilihan.

48
2017-07-09 19:25



Jika Anda menggunakan Eclipse dengan plugin yedit (editor untuk file .yaml), Anda dapat mengomentari beberapa baris dengan

  1. memilih garis untuk dikomentari, dan kemudian
  2. Ctrl + shift + c

dan untuk tidak berkomentar ikuti langkah yang sama.


7
2017-07-05 13:42



Emacs memiliki comment-dwim (Do What I Mean) - cukup pilih blok dan lakukan:

M-;

Ini toggle - gunakan untuk mengomentari dan blok uncomment.

Jika Anda tidak menginstal yaml-mode, Anda perlu memberi tahu Emacs untuk menggunakan karakter hash (#).


5
2017-11-20 00:17



Untuk pengguna Ruby Mine di Windows:

Buka file di editor Pilih blok dan tekan Ctrl+garis miring ke depan, Anda akan memilih blok yang dimulai dengan #.

Sekarang jika Anda ingin menghapus komentar pada blok komentar, tekan kombinasi tombol yang sama Ctrl+garis miring ke depan lagi


4
2017-12-25 18:13



Pendekatan alternatif:

Jika

  • Struktur YAML Anda memiliki bidang yang ditentukan dengan baik untuk digunakan oleh aplikasi Anda
  • DAN Anda dapat dengan bebas menambahkan bidang tambahan yang tidak akan mengacaukan aplikasi Anda

kemudian

  • pada tingkat apa pun Anda dapat menambahkan bidang teks blok baru bernama "Deskripsi" atau "Komentar" atau "Catatan" atau apa pun

Contoh:

Dari pada

# This comment
# is too long

menggunakan

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 berulang, Anda dapat mempromosikannya dari blok teks biasa ke objek
  2. Aplikasi Anda mungkin -di masa depan- membaca atau memperbarui komentar tersebut

3
2018-04-26 07:45



Satu-satunya cara untuk memblokir komentar di YAML adalah menggunakan aplikasi lain untuk menambahkan tag # (komentar) ke beberapa baris sekaligus. Contohnya adalah opsi klik kanan "Blok Komentar" untuk teks yang dipilih di Notepad ++.

Woo Images!


2
2018-05-04 00:10