Pertanyaan yang diberi tag «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 . Untuk komentar kontrol versi apa yang dilakukan / direkomendasikan pengguna lain - lampau …

12 comments  source-code 

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 publik di repositori saya juga. Sebagian besar blok hanya berisi …

12 php  comments 

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 banyak kelas yang ditulis ulang. Jadi saya memutuskan untuk menarik garis di …

11 refactoring  comments 

Apakah ada praktik umum untuk mengomentari ekspresi reguler: komentar inline merujuk bagian berbeda dari RegEx atau komentar umum untuk semua ekspresi?

11 documentation  coding-style  comments 

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 (antara setiap 8-12 bulan). Dia mengatakan …

11 coding-style  team  comments 

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 bawah komentar?

11 java  code-quality  api  comments 

Ketika saya menulis skrip kecil untuk diri saya sendiri, saya menumpuk kode saya tinggi dengan komentar (kadang-kadang saya berkomentar lebih dari saya kode). Banyak orang yang saya ajak bicara mengatakan bahwa saya harus mendokumentasikan skrip-skrip ini, meskipun bersifat pribadi, sehingga jika saya pernah menjualnya, saya akan siap. Tetapi bukankah komentar …

11 documentation  comments 

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 kita hanya menggunakan GhostDoc untuk menghasilkan komentar umum, …

10 .net  programming-practices  development-process  documentation  comments 

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 Studio. Namun ada satu bentuk redundansi, yang bahkan terganggu oleh …

10 documentation  comments  intellisense 

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 for equals } Perusahaan …

10 java  comments 

Saya menyadari bahwa format "header comment" bervariasi dari programmer ke programmer, tetapi apa yang akan menjadi contoh dari komentar header "bagus"?

10 c++  coding-style  comments  code-formatting  headers 

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 ErrorCode.UNEXPECTED_ARGUMENT: return "Unexpected argument"; case …

9 java  clean-code  comments  conventions 

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, "Perhatikan pada saluran XYZ bahwa ini-dan-itu terjadi." Dalam …

9 documentation  comments 

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

9 documentation  comments  dry  javadocs 

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 …

9 comments