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,...
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...
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...
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,...
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 . Untuk...
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...
Saya memiliki basis kode pribadi yang cukup besar yang telah berkembang selama sekitar sepuluh tahun sekarang. Saya tidak menggunakan phpDocumentor tetapi karena menggunakan bagian docblock telah menjadi standar dalam proyek open source, saya telah mengadopsi penulisan docblock untuk semua metode...
Saya ingin tahu cara terbaik untuk menambahkan komentar untuk mengidentifikasi kelas yang sudah usang di Jawa. Haruskah saya menghapus komentar sebelumnya yang ditambahkan ke bagian atas kelas yang membantu programmer lain untuk mengetahui untuk apa kelas itu, atau haruskah saya menambahkannya di...
Saya sedang mengerjakan proyek "kode-spaghetti", dan sementara saya memperbaiki bug dan mengimplementasikan fitur-fitur baru, saya juga melakukan beberapa refactoring untuk membuat unit kode dapat diuji. Kode sering kali sangat erat atau rumit sehingga memperbaiki bug kecil akan menghasilkan...
Apakah ada praktik umum untuk mengomentari ekspresi reguler: komentar inline merujuk bagian berbeda dari RegEx atau komentar umum untuk semua
Saya sedang berbicara dengan seorang rekan hari ini. Kami mengerjakan kode untuk dua proyek berbeda. Dalam kasus saya, saya satu-satunya orang yang mengerjakan kode saya; dalam kasusnya, banyak orang bekerja pada basis kode yang sama, termasuk siswa koperasi yang datang dan pergi secara teratur...
Apakah praktik yang baik untuk menulis komentar untuk metode yang dikenal luas seperti equals, compareTo dll? Pertimbangkan kode di bawah ini. /** * This method compares the equality of the current object with the object of same type */ @Override public boolean equals(Object obj) { //code...
Saya seorang pendukung kode yang terdokumentasi dengan baik, dan saya sangat menyadari kemungkinan kerugiannya . Itu di luar ruang lingkup pertanyaan ini. Saya suka mengikuti aturan menambahkan komentar XML untuk setiap anggota publik, mengingat betapa saya suka IntelliSense di Visual...
Saya menyadari bahwa format "header comment" bervariasi dari programmer ke programmer, tetapi apa yang akan menjadi contoh dari komentar header
Saya dulu penggemar yang membutuhkan komentar XML untuk dokumentasi. Sejak itu saya berubah pikiran karena dua alasan utama: Seperti kode yang baik, metode harus jelas. Dalam praktiknya, sebagian besar komentar XML adalah noise tidak berguna yang tidak memberikan nilai tambah. Banyak kali...
Saya ingin menulis Javadoc dengan cara KERING. Tetapi dokumen oracle tentang Javadoc mengatakan menulis hal yang sama lagi dalam komentar metode overload. Bisakah saya menghindari
Ini mungkin pertanyaan bodoh, tapi sudah ada di benak saya untuk sementara waktu dan saya tidak dapat menemukan jawaban yang layak di tempat lain. Saya memiliki guru yang mengatakan kita harus secara eksplisit mendaftar setiap parameter dengan deskripsi, meskipun hanya ada satu. Hal ini...
Saya sedang membaca Clean Code oleh Robert C. Martin, dan frasa tersebut secara TILTtak terduga muncul di beberapa contoh kode. Contoh (ada di Jawa, omong-omong): ... public String errorMessage() { switch (status) { case ErrorCode.OK: // TILT - Should not get here. return ""; case...
Saya akan meninggalkan proyek, dan sebelum saya pergi, bos saya telah meminta saya untuk mendokumentasikan kode (saya belum mendokumentasikan dengan baik). Ini bukan masalah besar, proyek ini tidak terlalu rumit. Tetapi saya menemukan tempat dalam dokumentasi saya di mana saya ingin mengatakan,...
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