15 Cara Menulis JavaScript Dokumen Sendiri

mata utama untuk menulis kod JavaScript yang didokumentasikan sendiri

Artikel ini akan meneroka cara menulis kod JavaScript yang didokumentasikan sendiri dan dikekalkan sendiri melalui teknik berstruktur, penamaan konvensyen dan teknik sintaks. Walaupun kod yang didokumentasikan sendiri dapat mengurangkan keperluan untuk komen, ia tidak sepenuhnya menggantikan komen yang baik dan dokumentasi komprehensif.

Kemahiran teras

• Teknologi berstruktur: Gerakkan kod ke dalam fungsi, menggantikan ekspresi bersyarat dengan fungsi, dan gunakan fungsi tulen untuk menjadikan kod lebih jelas dan mudah difahami.
• Penamaan Konvensyen: Pembolehubah nama, fungsi, dan kelas dengan nama yang bermakna untuk meningkatkan kebolehbacaan kod.
• Kemahiran sintaks: Elakkan menggunakan teknik sintaks, gunakan pemalar yang dinamakan dan membuat kod lebih jelas.
• Ekstrak Kod dengan berhati-hati: Elakkan kod pengekstrakan yang lebih tinggi dalam mengejar fungsi pendek, yang dapat mengurangkan komprehensif Kod.

Gambaran keseluruhan teknikal

Kami membahagikan kod yang didokumentasikan sendiri ke dalam tiga kategori:

• Struktur: Gunakan struktur kod atau direktori untuk menjelaskan tujuan kod.
• Nama yang berkaitan: Sebagai contoh, penamaan fungsi atau pembolehubah.
• Sintaks berkaitan: Gunakan (atau mengelakkan) Ciri -ciri bahasa untuk menjadikan kod lebih jelas.

Teknologi berstruktur

• Pindahkan kod ke dalam fungsi: Pindahkan kod sedia ada ke dalam fungsi baru untuk menjadikan fungsinya lebih jelas. Sebagai contoh, boleh ditulis semula sebagai: var width = (value - 0.5) * 16;

var width = emToPixels(value);

function emToPixels(ems) {
    return (ems - 0.5) * 16;
}

• Gantikan ekspresi bersyarat dengan fungsi:

  Tukar pernyataan bersyarat kompleks ke dalam fungsi untuk meningkatkan kebolehbacaan.

• Gantikan ekspresi dengan pembolehubah:

  Mengurangkan ekspresi kompleks ke dalam pelbagai pembolehubah untuk meningkatkan komprehensif.

• antara muka kelas dan modul:

  Kaedah dan sifat awam kelas boleh digunakan sebagai dokumentasi penggunaannya. Antara muka yang jelas boleh mencerminkan penggunaan kelas secara langsung.

• Pengumpulan kod:

  Kod berkaitan pengelompokan boleh menunjukkan bahawa terdapat hubungan antara kod dan memudahkan penyelenggaraan.

• Gunakan fungsi tulen:

  Fungsi tulen lebih mudah difahami kerana output mereka hanya bergantung pada parameter input dan tidak mempunyai kesan sampingan.

• Struktur Direktori dan Fail:

  Susun fail dan direktori mengikut konvensyen penamaan sedia ada dalam projek untuk memudahkan carian dan pemahaman kod.

Penamaan Kemahiran

• Nama semula fungsi:

  Gunakan kata kerja dalam suara aktif dan secara eksplisit menunjukkan nilai pulangan. Elakkan menggunakan kata -kata samar seperti "pemegang" atau "menguruskan".

• Nama semula Variable:

  Gunakan nama yang bermakna dan tentukan unit (mis. ). Elakkan menggunakan singkatan.

• mematuhi konvensyen penamaan yang ditetapkan: Mengekalkan gaya penamaan yang konsisten dalam projek.

• Gunakan mesej ralat yang bermakna: Pastikan mesej ralat yang dibuang oleh kod adalah deskriptif dan mengandungi maklumat yang relevan yang menyebabkan ralat.

kemahiran tatabahasa

• Elakkan menggunakan petua tatabahasa: Elakkan menggunakan tip tatabahasa yang sukar difahami, seperti imTricky && doMagic();, dan gunakan penyataan yang lebih jelas if.

• Gunakan pemalar yang dinamakan untuk mengelakkan nilai sihir: Gunakan pemalar yang dinamakan dan bukan nilai sihir untuk meningkatkan kebolehbacaan kod dan kebolehkerjaan.

• Elakkan bendera boolean: bendera boolean boleh membuat kod sukar difahami dan harus dipertimbangkan untuk pendekatan yang lebih jelas.

• Dapatkan penggunaan penuh ciri bahasa: Gunakan ciri -ciri yang disediakan oleh bahasa, seperti kaedah lelaran array, untuk menjadikan kod lebih ringkas dan mudah difahami.

anti-mod

• overextracting code untuk fungsi pendek:

  Elakkan kod overextracting untuk meneruskan fungsi pendek, yang dapat mengurangkan pemantauan kod.

• Jangan paksa:

  Jika kaedah tidak sesuai, jangan memaksanya menggunakannya.

Ringkasan

Menulis kod yang didokumentasikan sendiri dapat meningkatkan pemeliharaan kod dan mengurangkan keperluan untuk komen. Walau bagaimanapun, kod yang didokumentasikan sendiri tidak dapat menggantikan dokumen atau komen sepenuhnya. Anotasi yang baik dan dokumentasi API masih penting untuk projek besar.

Atas ialah kandungan terperinci 15 Cara Menulis JavaScript Dokumen Sendiri. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!