Pertanyaan yang diberi tag «comments»

Kami telah diminta untuk menambahkan komentar dengan tag awal, tag akhir, deskripsi, solusi dll untuk setiap perubahan yang kami lakukan pada kode sebagai bagian dari perbaikan bug / penerapan CR. Kekhawatiran saya adalah, apakah ini memberikan nilai tambah? Karena itu, kami memiliki semua detail dalam riwayat kontrol Versi, yang akan …

42 version-control  bug  comments  change 

Apakah ini praktik yang baik untuk memasukkan nomor bug dalam file itu sendiri di dalam komentar header? Komentar akan terlihat seperti ini: MODIFIED (MM/DD/YY) abc 01/21/14 - Bug 17452317 - npe in drill across in dashboard edit mode cde 01/17/14 - Bug 2314558 - some other error description Tampaknya membantu, …

40 version-control  development-process  source-code  comments 

Saya terus-menerus melihat orang-orang membuat klaim bahwa "komentar cenderung menjadi ketinggalan zaman." Masalahnya, saya pikir saya telah melihat mungkin dua atau tiga komentar usang sepanjang karir saya. Informasi yang sudah ketinggalan zaman dalam dokumen terpisah terjadi setiap saat, tetapi dalam pengalaman saya komentar yang ketinggalan zaman dalam kode itu sendiri …

38 comments  myth 

Sepanjang program, Anda akan berakhir dengan beberapa komentar yang menjelaskan kode dan beberapa komentar yang menghapus kode: // A concise description const a = Boolean(obj); //b = false; Apakah ada metode yang baik untuk mem-parsing yang mana? Saya telah bermain-main dengan menggunakan 3 /dan /** */untuk komentar deskriptif. Saya juga …

38 javascript  comments 

Dengan asumsi komentar tidak sesuai (atau tidak bisa) pada baris yang berlaku, haruskah seseorang menulis komentar sebelum kode atau setelahnya? Nah, di mana pun pembaca di masa depan akan lebih memahami ruang lingkup komentar. Dengan kata lain, di mana pun kebanyakan programmer / penulis naskah memberikan komentar seperti itu. Jadi …

34 comments 

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 'mengganggu' token atau tidak? Secara umum, adalah sesuatu seperti: Sys/* comment …

31 parsing  comments 

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 dijawab di Rekayasa Perangkat Lunak Stack Exchange. Bermigrasi 8 tahun yang lalu . Apakah ada …

27 language-agnostic  comments 

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 melihat ini ditanyakan di SO Tavern , jadi saya memposting pertanyaan di …

27 source-code  comments  coding-style  grammar 

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 paling mudah dan informatif? Kebiasaan apa yang Anda miliki ketika …

26 coding-style  comments 

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 memulai dengan pemrograman fungsional dan saya bertanya-tanya tentang cara yang benar …

25 functional-programming  comments 

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 menghadapi sesuatu seperti …

23 java  c++  python  c  comments 

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 diajukan. Awal bulan ini posting ini dibuat: http://net.tutsplus.com/tutorials/php/why-youre-a-bad-php-programmer/ Pada dasarnya, Anda …

22 coding-standards  comments 

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 saya ubah. Saya memperlakukan kode yang dikomentari …

21 anti-patterns  comments 

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 kelas, dan Java IDEs bagus dalam membuat shell komentar untuk Anda. …

20 java  python  clojure  comments 

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 (seperti dalam kasus di atas), dan "salah" dimaksudkan untuk meniadakannya? …

19 coding-style  comments  boolean