Apakah spesifikasi pengekodan komen bahasa go?

Spesifikasi pengekodan anotasi: 1. Semua objek yang dieksport perlu diberi anotasi untuk menerangkan tujuannya; 2. Jika objek boleh dikira dan kuantitinya tidak dinyatakan dengan jelas, sentiasa gunakan bentuk tunggal dan kala berterusan berterusan jika tidak, gunakan bentuk jamak. 3. Komen untuk pakej, fungsi, kaedah dan jenis semuanya adalah ayat yang lengkap. 4. Huruf pertama ulasan jenis ayat hendaklah ditulis dengan huruf besar; 5. Panjang satu baris ulasan tidak boleh melebihi 80 aksara.

Persekitaran pengendalian tutorial ini: sistem Windows 7, GO versi 1.18, komputer Dell G3.

Maksud ulasan

• Komen boleh membantu kami menyelesaikan kerja dokumen dengan baik dapat memudahkan penyelenggaraan kami pada masa hadapan. Terdapat dua gaya ulasan: ulasan sekat

• /**/ dan ulasan satu baris // Untuk menyatukan gaya, semua ulasan satu baris digunakan dalam kami projek. Kualiti ulasan menentukan Kualiti dokumentasi yang dihasilkan.

Spesifikasi anotasi

• Semua objek yang dieksport perlu diberi anotasi untuk menerangkan tujuannya;

• Jika objek boleh dikira dan kuantitinya tidak dinyatakan secara eksplisit, sentiasa gunakan bentuk tunggal dan kala berterusan berterusan jika tidak, gunakan bentuk jamak.

• Komen untuk pakej, fungsi, kaedah dan jenis semuanya dalam ayat yang lengkap.

• Huruf pertama ulasan jenis ayat hendaklah menggunakan huruf besar huruf pertama ulasan jenis frasa mestilah huruf kecil.

• Panjang satu baris ulasan tidak boleh melebihi 80 aksara.

1. Tahap pakej

Komen peringkat pakej ialah pengenalan kepada pakej dan hanya perlu diletakkan dalam mana-mana fail sumber bagi pakej yang sama Penerangan adalah sah. [Cadangan berkaitan: Pergi tutorial video, Pengajaran pengaturcaraan]

• Setiap pakej harus mempunyai ulasan pakej, satu terletak dalam klausa pakej ulasan baris sebelumnya

• ulasan pakej hendaklah mengandungi maklumat asas berikut

// @Title  请填写文件名称（需要改）
// @Description  请填写文件描述（需要改）
// @Author  请填写自己的真是姓名（需要改）  ${DATE} ${TIME}
// @Update  请填写自己的真是姓名（需要改）  ${DATE} ${TIME}
package ${GO_PACKAGE_NAME}

2. Struktur (antara muka) ulasan

Setiap struktur atau antara muka tersuai harus mempunyai penerangan ulasan. Ulasan secara ringkas memperkenalkan struktur dan diletakkan pada baris sebelum definisi struktur. Pada masa yang sama, setiap pembolehubah ahli dalam struktur mesti mempunyai penerangan diletakkan selepas pembolehubah ahli (perhatian kepada penjajaran contohnya:

// User   用户对象，定义了用户的基础信息
type User struct{
    Username  string // 用户名
    Email     string // 邮箱
}

3). . Fungsi (kaedah) ulasan

• Setiap fungsi atau kaedah (fungsi di bawah struktur atau antara muka dipanggil kaedah) harus mempunyai ulasan yang menerangkan

• fungsi Komen hendaklah merangkumi tiga aspek

// @title    函数名称
// @description   函数的详细描述
// @auth      作者             时间（2019/6/18   10:57 ）
// @param     输入参数名        参数类型         "解释"
// @return    返回参数名        参数类型         "解释"

4. Komen logik kod

• Setiap kod blok mesti Tambah komen satu baris

• Beri perhatian kepada penggunaan TODO Butirannya adalah seperti berikut

// TODO  代码块的执行解释
if   userAge < 18 {

}

. Arahan lain

• Apabila bahagian tertentu sedang menunggu untuk siap, ulasan bermula dengan TODO: boleh digunakan untuk mengingatkan penyelenggara.

• Apabila bahagian tertentu mempunyai masalah yang diketahui yang perlu diperbaiki atau diperbaiki, anda boleh menggunakan ulasan bermula dengan FIXME: untuk mengingatkan penyelenggara.

• Apabila anda perlu menjelaskan masalah secara khusus, anda boleh menggunakan ulasan bermula dengan NOTE::

  // NOTE: os.Chmod and os.Chtimes don't recognize symbolic link,
  // which will lead "no such file or directory" error.
  return os.Symlink(target, dest)

Untuk lebih banyak pengaturcaraan- pengetahuan berkaitan, Sila layari: Pengenalan kepada Pengaturcaraan! !

Atas ialah kandungan terperinci Apakah spesifikasi pengekodan komen bahasa go?. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!