Menambahkan Komentar di ASP

• Mungkin 21, 2024

Terkadang hal-hal sederhana yang membingungkan orang. Bagaimana Anda menambahkan komentar ke kode ASP Anda, agar lebih mudah dibaca dan didokumentasikan?

Ini sangat mudah - Anda hanya menempatkan tanda kutip tunggal (') di awal baris ASP Anda. Jadi kode Anda mungkin terlihat seperti ini -

'inisialisasi variabel'
CurrMonth = permintaan ("m")
CurrDay = request ("d")

Perhatikan bahwa saya meletakkan tanda kutip sebelum DAN setelah komentar saya. Anda tidak harus melakukan itu. Tetapi saya menggunakan editor TextPad (yang sangat saya rekomendasikan) dan secara otomatis menyoroti hal-hal berdasarkan di mana tanda kutip dimulai dan berakhir. Jadi dengan meletakkan satu di setiap ujung komentar saya, saya mengubah semuanya dengan warna yang berbeda.

Komentar TIDAK ditafsirkan sehingga Anda dapat memasukkan apa pun yang Anda inginkan ke dalamnya. Namun, sementara komentar penting untuk melacak apa yang Anda lakukan, saya TIDAK merekomendasikan memasukkan banyak komentar ke dalam kode Anda. Ingat, seluruh file Anda harus diuraikan dan diproses sebelum hasilnya dikirim ke pengguna akhir. Jika Anda menulis War and Peace dalam komentar Anda, perlu beberapa saat sebelum file tersebut sampai ke pengguna akhir Anda - artinya mereka bisa menyerah dan pergi ke tempat lain. Anda ingin laman ASP langsung Anda dibuat sesederhana mungkin.

Jadi saya sarankan memasukkan komentar di atas setiap blok kode utama, jadi jika Anda harus masuk dan men-debug-nya beberapa bulan kemudian Anda dapat mengingat apa yang Anda lakukan. Mungkin menambahkan satu atau dua baris di bagian atas dengan tanggal perubahan terakhir dan nama penulis. Tetapi biarkan semua dokumentasi yang kuat terpisah. Tujuan utama kode ASP pada akhirnya adalah untuk membuat halaman web bagi pengguna - dan dalam hal itu, tindakan cepat adalah yang terpenting.

Petunjuk Video: VB.NET - Input Data menggunakan DataBase MySQL (Mungkin 2024).