Pertanyaan yang diberi tag «comments»

Banyak orang mengklaim bahwa "komentar harus menjelaskan 'mengapa', tetapi tidak 'bagaimana'". Yang lain mengatakan bahwa "kode harus mendokumentasikan diri sendiri" dan komentar harus langka. Robert C. Martin mengklaim bahwa (diucapkan dengan kata-kata saya sendiri) sering "komentar adalah permintaan maaf untuk kode yang ditulis dengan buruk". Pertanyaan saya adalah sebagai berikut: …

236 programming-practices  documentation  comments 

Salah satu anggota tim saya secara konsisten menghindari membuat komentar dalam kodenya. Kode-nya tidak mendokumentasikan diri sendiri, dan programmer lain kesulitan memahami kode-nya. Saya telah memintanya beberapa kali untuk mengomentari kodenya, namun dia hanya memberikan alasan atau klaim bahwa dia akan melakukannya nanti. Kekhawatirannya adalah bahwa menambahkan komentar akan memakan …

184 teamwork  team  comments 

Saya telah bekerja di toko-toko yang menghasilkan perangkat lunak yang sangat penting dan saya telah berurusan dengan aturan komentar yang dimaksudkan agar kode tersebut dapat dibaca dan berpotensi menyelamatkan nyawa. Dalam pengalaman saya meskipun persyaratan menjadi tugas yang mematikan otak untuk dicentang dari daftar periksa dan tidak membantu saya tetap …

142 coding-standards  comments  standards  naming-standards  standardization 

Seorang rekan kerja saya percaya bahwa setiap penggunaan komentar dalam kode (yaitu, bukan metode gaya javadoc atau komentar kelas) adalah bau kode . Bagaimana menurut anda?

100 comments  anti-patterns 

pengembang junior di sini. Saat ini saya bekerja sendiri di aplikasi web untuk klien besar perusahaan saya. Saya mulai bulan lalu. Klien menginginkan setidaknya 25% komentar di setiap proyek perangkat lunaknya. Saya memeriksa kode aplikasi sebelumnya dan berikut adalah pengamatan saya: setiap file dimulai dengan blok komentar (paket, tanggal terakhir …

96 project-management  comments  client-relations  hierarchy 

Saya mengerjakan proyek yang cukup besar dan mendapat tugas untuk melakukan beberapa terjemahan untuknya. Ada banyak label yang belum diterjemahkan dan ketika saya sedang menggali kode, saya menemukan sepotong kode ini //TODO translations Ini membuat saya berpikir tentang arti dari komentar-komentar ini untuk diri Anda sendiri (dan yang lainnya?) Karena …

86 documentation  comments 

Saya sedang berdiskusi dengan kolega baru saya mengenai komentar. Kami berdua menyukai Kode Bersih , dan saya baik-baik saja dengan fakta bahwa komentar kode sebaris harus dihindari dan bahwa nama kelas dan metode harus digunakan untuk mengekspresikan apa yang mereka lakukan. Namun, saya penggemar menambahkan ringkasan kelas kecil yang mencoba …

83 comments  clean-code 

Saya menulis kode berikut: if (boutique == null) { boutique = new Boutique(); boutique.setSite(site); boutique.setUrlLogo(CmsProperties.URL_FLUX_BOUTIQUE+fluxBoutique.getLogo()); boutique.setUrlBoutique(CmsProperties.URL_FLUX_BOUTIQUE+fluxBoutique.getUrl()); boutique.setNom(fluxBoutique.getNom()); boutique.setSelected(false); boutique.setIdWebSC(fluxBoutique.getId()); boutique.setDateModification(new Date()); boutiqueDao.persist(boutique); } else { boutique.setSite(site); boutique.setUrlLogo(CmsProperties.URL_FLUX_BOUTIQUE+fluxBoutique.getLogo()); boutique.setUrlBoutique(CmsProperties.URL_FLUX_BOUTIQUE+fluxBoutique.getUrl()); boutique.setNom(fluxBoutique.getNom()); //boutique.setSelected(false); boutique.setIdWebSC(fluxBoutique.getId()); boutique.setDateModification(new Date()); boutiqueDao.merge(boutique); } Ada garis komentar di sini. Tapi saya pikir itu membuat kode lebih jelas, dengan memperjelas …

83 documentation  comments 

Pertama-tama, dalam pertanyaan ini saya ingin menjauh dari polemik apakah komentar kode sumber itu baik atau buruk. Saya hanya mencoba memahami dengan lebih jelas apa yang dimaksud orang ketika mereka berbicara tentang komentar yang memberi tahu Anda MENGAPA, APA atau BAGAIMANA. Kita sering melihat pedoman seperti "Komentar harus memberi tahu …

78 documentation  comments 

Saya tahu bahwa Subversion (apa yang kami gunakan di tempat kerja) dapat dikonfigurasikan untuk memerlukan komentar saat melakukan, namun saya tidak dalam posisi yang kuat untuk mengaktifkannya. Saya tahu bahwa alasan saya berkomentar tentang komitmen saya adalah karena berguna, jika hanya sebagai pelari memori, untuk dengan cepat memahami alasan di …

78 version-control  comments 

Saya diajari oleh bos saya (saya baru saja selesai sekolah dan dia menginginkan seseorang dengan sedikit pengalaman pemrograman, jadi dia memilih saya untuk melatih saya tentang apa yang menjadi spesialisasi perusahaan itu) dan mulai bekerja dengan aplikasi ASP.NET MVC , beberapa HTML dan CSS . Saya baik-baik saja dengan hal-hal …

72 comments 

Apa yang orang umumnya maksud setiap kali Anda melihat XXXdi komentar. Terkadang, saya akan melihat komentar seperti ini: # XXX - This widget really should frobulate the whatsit Tentu saja, saya dapat mengatakan apa arti komentar tersebut, tetapi apa arti XXX secara umum? Apakah itu mengatakan "Ini hack" atau mungkin …

72 comments  coding-standards 

Saya baru saja menemukan diri saya menulis komentar berikut dalam beberapa kode (kuno Visual Basic 6.0) yang saya tulis: If WindowState <> 1 Then 'The form's not minimized, so we can resize it safely '... End if Saya tidak yakin mengapa saya secara tidak sadar menggunakan "kami" dalam komentar saya. …

63 comments  coding-standards 

Latar Belakang Saya bekerja di tim yang ingin menerapkan penerapan zero-downtime. Kami berencana menggunakan strategi penyebaran biru / hijau untuk mencapai ini. Salah satu hal yang saya sadari dalam melakukan penelitian adalah betapa rumitnya membuat perubahan database. Operasi sederhana seperti mengganti nama kolom dapat memakan waktu 3 siklus rilis penuh …

51 continuous-integration  deployment  comments  continuous-delivery 

Seseorang pernah berkata kita harus mengawali semua metode kita dengan /// <summary>blok komentar (C #) tetapi tidak menjelaskan mengapa. Saya mulai menggunakannya dan menemukan mereka sedikit mengganggu saya, jadi berhenti menggunakannya kecuali untuk perpustakaan dan metode statis. Mereka besar dan saya selalu lupa memperbaruinya. Apakah ada alasan bagus untuk menggunakan …

49 c#  comments