Untuk meningkatkan keterbacaan kode, Anda dapat menambahkan komentar dalam skrip SQL MaxCompute. Topik ini menjelaskan cara menggunakan komentar satu baris dan multi-baris dalam skrip SQL MaxCompute.
Batasan
Fitur komentar multi-baris tidak tersedia di antarmuka pengembangan data DataWorks.
Untuk menggunakan komentar SQL di klien lokal (odpscmd) MaxCompute, versi odpscmd harus 0.49.0 atau lebih baru.
Saat menggunakan komentar satu baris di MaxCompute client (odpscmd) atau Cloud Shell (odpscmd), titik koma (;) diperlukan untuk menghentikan tugas komentar. Titik koma tidak didukung dalam komentar multi-baris.
Format sintaksis
Komentar satu baris
Mulai komentar satu baris dengan --. Sintaksnya adalah sebagai berikut:
-- Isi komentarTeks apa pun setelah -- hingga akhir baris dianggap sebagai komentar. Komentar dapat ditempatkan pada baris terpisah di atas kode atau di akhir baris kode.
Di antarmuka analisis SQL konsol MaxCompute atau antarmuka pengembangan data DataWorks, Anda dapat menggunakan pintasan Ctrl+/ untuk memberi komentar pada baris kode.
Komentar multi-baris
Untuk komentar multi-baris, gunakan /* untuk memulai dan */ untuk mengakhiri, sehingga memungkinkan Anda memberi komentar pada blok konten sekaligus. Sintaksnya adalah sebagai berikut:
/*
Isi
komentar
*/MaxCompute juga mendukung /*+...*/ sebagai sintaks Hint, seperti MAPJOIN hints dan SKEWJOIN HINT. Hint memiliki prioritas lebih tinggi daripada komentar multi-baris, jadi pastikan simbol awal komentar multi-baris tidak disalahartikan sebagai simbol awal Hint. Kami menyarankan Anda menggunakan /** sebagai simbol awal untuk komentar multi-baris guna menghindari kebingungan.
Contoh penggunaan
Pertimbangkan my_table sebagai tabel yang sudah ada. Kode berikut menunjukkan contoh penggunaan komentar:
Contoh 1: Komentar satu baris yang benar.
-- Komentar satu baris DESC my_table; -- Komentar satu barisContoh 2: Komentar multi-baris yang benar.
SELECT /* Valid multi-baris komentar */ * FROM my_table;Contoh 3: Komentar multi-baris yang salah di mana
/*+salah diartikan sebagai awal dari sebuah Hint.SELECT /*+ Invalid multi-baris komentar */ * FROM my_table;