Pertanyaan yang diberi tag «comments»

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. /// </summary> public int ID { get; set; } Tetapi karena …

19 c#  .net  programming-practices  comments 

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 ini?

18 comments  issue-tracking 

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 buruk.

18 language-agnostic  syntax  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 sering melihat komentar seperti itu digunakan: function foo() { ... } // …

18 source-code  comments 

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 1234. Kami menggunakan TFS untuk kontrol revisi, dan menurut saya komentar …

17 coding-standards  comments 

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 segera jelas untuk apa parameter Anda, …

17 java  documentation  source-code  comments  maintainability 

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: // We're now mapping from the "sorted-on column" to …

16 comments 

Apakah dianggap praktik yang buruk untuk membuang NotImplementedExceptionkode yang belum Anda tulis? Mungkin komentar TODO akan dianggap lebih aman?

15 .net  comments  coding  exceptions 

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 . Ditutup 8 tahun yang lalu . Hanya karena penasaran, saya …

15 comments 

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 pertanyaan ini dapat diperbaiki dan mungkin dibuka kembali, kunjungi pusat bantuan …

15 comments 

Pertimbangkan penanda konflik. yaitu: <<<<<<< branch blah blah this ======= blah blah that >>>>>>> HEAD Dalam kasus tertentu yang memotivasi saya untuk mengirim pertanyaan ini, anggota tim yang bertanggung jawab baru saja menyelesaikan penggabungan dari hulu ke cabang kami, dan dalam beberapa kasus meninggalkannya, sebagai komentar, sebagai semacam dokumentasi tentang …

14 version-control  comments  coding-style 

Saya menulis banyak kode (terutama c ++ dan javascript) yang menyentuh pada komputasi geometri dan grafik dan topik-topik semacam itu, jadi saya telah menemukan bahwa diagram visual telah menjadi bagian tak terpisahkan dari proses penyelesaian masalah. Saya baru saja memutuskan bahwa "oh, bukankah akan fantastis jika saya bisa melampirkan diagram …

14 productivity  code-reviews  comments  workflows  image-manipulation 

Kami sedang melakukan refactoring ke basis kode lama 20 tahun, dan saya sedang berdiskusi dengan rekan saya tentang format komentar dalam kode (plsql, java). Tidak ada format default untuk komentar, tetapi dalam kebanyakan kasus orang melakukan sesuatu seperti ini di komentar: // date (year, year-month, yyyy-mm-dd, dd/mm/yyyy), (author id, author …

13 java  c#  programming-practices  code-quality  comments 

Saya mencari format dokumentasi kelas informatif untuk kelas Entitas, Logika Bisnis, dan Akses Data saya. Saya menemukan dua format berikut dari sini Format 1 ///----------------------------------------------------------------- /// Namespace: <Class Namespace> /// Class: <Class Name> /// Description: <Description> /// Author: <Author> Date: <DateTime> /// Notes: <Notes> /// Revision History: /// Name: Date: …

13 c#  documentation  comments 

Apakah gaya yang baik untuk menggunakan variabel lokal tambahan yang secara teknis berlebihan untuk menggambarkan apa yang terjadi? Sebagai contoh: bool easyUnderstandableIsTrue = (/* rather cryptic boolean expessions */); if(easyUnderstandableIsTrue) { // ... } Ketika datang ke overhead teknis saya berharap kompiler untuk mengoptimalkan baris tambahan ini pergi. Tetapi apakah …

12 coding-style  comments