Bagaimana komentar umumnya diperlakukan dalam bahasa pemrograman dan markup? Saya menulis parser untuk beberapa bahasa markup kustom dan ingin mengikuti prinsip paling tidak mengejutkan , jadi saya mencoba menentukan konvensi umum. Misalnya, haruskah komentar yang tertanam di dalam token...
Ingin memperbaiki pos ini? Berikan jawaban terinci untuk pertanyaan ini, termasuk kutipan dan penjelasan mengapa jawaban Anda benar. Jawaban tanpa detail yang cukup dapat diedit atau dihapus. Pertanyaan ini dimigrasikan dari Stack Overflow karena dapat...
Ditutup . Pertanyaan ini didasarkan pada pendapat . Saat ini tidak menerima jawaban. Ingin meningkatkan pertanyaan ini? Perbarui pertanyaan sehingga dapat dijawab dengan fakta dan kutipan dengan mengedit posting ini . Ditutup 5 tahun yang lalu . Saya...
Pertanyaan ini dimigrasikan dari Stack Overflow karena dapat dijawab di Rekayasa Perangkat Lunak Stack Exchange. Bermigrasi 8 tahun yang lalu . Saya ingin mendengar dari Anda saran dan pengalaman menulis komentar dalam kode Anda. Bagaimana Anda menulisnya dengan cara yang...
Ditutup . Pertanyaan ini didasarkan pada pendapat . Saat ini tidak menerima jawaban. Ingin meningkatkan pertanyaan ini? Perbarui pertanyaan sehingga dapat dijawab dengan fakta dan kutipan dengan mengedit posting ini . Ditutup 4 tahun yang lalu . Saya baru...
Tampaknya tidak hanya dalam satu bahasa bahwa komentar tidak dapat disarangkan. Apakah Anda punya solusi yang baik untuk masalah ini? Salah satu solusi di C / C ++ dan Java adalah dengan hanya menggunakan komentar single-line tetapi menjadi mustahil untuk berkomentar di blok yang lebih besar. Saya...
Terkunci . Komentar untuk pertanyaan ini telah dinonaktifkan, tetapi masih menerima jawaban baru dan interaksi lainnya. Pelajari lebih lanjut . Saya telah mencari tetapi tidak menemukan apa yang saya cari, jangan ragu untuk menautkan saya jika pertanyaan ini sudah
Setiap kali saya mengetahui bahwa sebagian besar kode saya perlu diubah, baik karena itu tidak benar atau karena perlu disesuaikan dengan perubahan arsitektur utama yang diperlukan oleh alasan lain, inilah yang biasanya saya lakukan: Saya berkomentar semua kode yang saya curigai mungkin harus...
Pertanyaan ini dimigrasikan dari Stack Overflow karena dapat dijawab di Rekayasa Perangkat Lunak Stack Exchange. Bermigrasi 7 tahun yang lalu . Mengomentari saat ini lebih mudah dari sebelumnya. Di Java, ada beberapa teknik yang bagus untuk menghubungkan komentar ke
Dari beberapa proyek open source, saya mengumpulkan gaya pengkodean berikut void someFunction(bool forget); void ourFunction() { someFunction(false /* forget */); } Saya selalu ragu tentang apa falseartinya di sini. Apakah ini berarti "lupa", atau "lupa" merujuk pada parameter yang sesuai...
Saya mencari rekomendasi praktik terbaik untuk komentar XML di C #. Saat Anda membuat properti, sepertinya dokumentasi XML yang diharapkan memiliki bentuk berikut: /// <summary> /// Gets or sets the ID the uniquely identifies this <see cref="User" /> instance. ///
Ditutup . Pertanyaan ini didasarkan pada pendapat . Saat ini tidak menerima jawaban. Ingin meningkatkan pertanyaan ini? Perbarui pertanyaan sehingga dapat dijawab dengan fakta dan kutipan dengan mengedit posting ini . Ditutup 4 tahun yang lalu . Saya...
Saya melihat banyak nomor terbitan dari komentar kode jQuery . (Sebenarnya, ada 69 nomor masalah dalam kode jQuery.) Saya pikir ini akan menjadi praktik yang baik, tetapi saya belum pernah melihat pedoman apa pun. Jika ini merupakan praktik yang baik, apa pedoman untuk praktik
Beberapa melakukannya, tetapi tidak ada yang populer sejauh yang saya tahu. Apakah ada hal buruk tentang komentar bersarang? Saya berencana memblokir komentar di bahasa (kecil) yang saya kerjakan, tapi saya ingin tahu apakah ini ide yang
Salah satu devs di tim saya percaya bahwa perlu untuk menulis komentar javadoc untuk setiap parameter dalam tanda tangan metode. Saya tidak berpikir ini perlu, dan bahkan saya pikir itu bisa berbahaya. Pertama, saya pikir nama parameter harus deskriptif dan mendokumentasikan diri. Jika tidak...
Pengembang senior di toko kami bersikeras bahwa setiap kali kode dimodifikasi, programmer yang bertanggung jawab harus menambahkan komentar sebaris yang menyatakan apa yang dia lakukan. Komentar-komentar ini biasanya terlihat seperti// YYYY-MM-DD <User ID> Added this IF block per bug...
Dalam beberapa basis kode Anda dapat melihat komentar yang menyatakan hal-hal seperti: // Workaround for defect 'xxx', (See bug 1434594 on Sun's bugparade) Jadi saya punya beberapa pertanyaan, tetapi semuanya terkait. Apakah boleh menempatkan tautan ke pertanyaan SO dalam komentar program:...
Seperti yang ada saat ini, pertanyaan ini tidak cocok untuk format tanya jawab kami. Kami berharap jawaban didukung oleh fakta, referensi, atau keahlian, tetapi pertanyaan ini kemungkinan akan mengundang debat, argumen, polling, atau diskusi panjang. Jika Anda merasa bahwa
Apakah dianggap praktik yang buruk untuk membuang NotImplementedExceptionkode yang belum Anda tulis? Mungkin komentar TODO akan dianggap lebih
Sulit mengatakan apa yang ditanyakan di sini. Pertanyaan ini ambigu, samar, tidak lengkap, terlalu luas, atau retoris dan tidak dapat dijawab secara wajar dalam bentuknya saat ini. Untuk bantuan mengklarifikasi pertanyaan ini sehingga dapat dibuka kembali, kunjungi pusat bantuan ....