Pertanyaan yang diberi tag «documentation»

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 6 tahun yang lalu . tujuannya adalah untuk memiliki sistem dokumentasi online, dengan persyaratan utama ini: akan terutama …

11 documentation 

Prinsip KERING (Jangan Ulangi Diri Sendiri) menyatakan bahwa "setiap pengetahuan harus memiliki perwakilan tunggal, tidak ambigu, berwibawa dalam suatu sistem." Sebagian besar waktu ini mengacu pada kode, tetapi sering juga diperluas ke dokumentasi. Dikatakan bahwa setiap sistem perangkat lunak memiliki arsitektur apakah Anda memilihnya atau tidak. Dengan kata lain, perangkat …

11 agile  documentation  architecture  dry 

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 …

11 project-management  business  management  documentation 

Perangkat lunak kami memiliki beberapa kelas yang harus ditemukan secara dinamis melalui refleksi. Kelas-kelas semua memiliki konstruktor dengan tanda tangan tertentu di mana kode refleksi instantiate objek. Namun, ketika seseorang memeriksa apakah metode ini dirujuk (misalnya melalui Visual Code Code Lens), referensi melalui refleksi tidak dihitung. Orang-orang dapat kehilangan referensi …

11 c#  .net  documentation  reflection 

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 

Menurut pendapat saya, kasus uji unit itu sendiri berfungsi sebagai dokumentasi untuk kode. Perusahaan saya ingin saya menulis komentar java doc terperinci di atas unit test unit. Apakah perlu melakukannya? Apakah Anda menulis komentar seperti itu?

11 unit-testing  documentation 

Kami membuat perpustakaan komersial dan contoh kode yang digunakan oleh pengembang eksternal. Kami memiliki (tertutup, tersedia untuk pengguna terdaftar) dokumentasi yang secara luas menjelaskan cara menggunakan perpustakaan. Banyak pengembang adalah pengguna pertama kali, sehingga banyak kesalahan mendasar yang ditemui. Apakah pantas memasukkan tautan ke dokumentasi di log kesalahan? Apa kemungkinan …

10 documentation  api-design  error-handling  error-messages 

Saya adalah pengembang amatir dan semua program saya sampai sekarang cukup sederhana untuk didokumentasikan dalam kode. Saat membaca kode jelas apa yang saya lakukan ini dan itu tindakan (tes standar saya adalah melihat kode 6 bulan kemudian dan memahami semuanya pada awalnya membaca - dan saya memiliki rentang memori pendek). …

10 architecture  documentation 

Saya adalah satu-satunya pengembang di proyek yang, seperti proyek perangkat lunak apa pun, dapat diambil oleh orang lain di masa mendatang. Katakanlah saya menggunakan pola X untuk mengimplementasikan fitur A. Setelah mengembangkan dan menyelesaikan fitur, saya menyadari bahwa saya dapat mengimplementasikan fitur yang sama menggunakan pola Y, yang baru saja …

10 design-patterns  refactoring  documentation 

Informasi apa yang akan Anda lihat di README github? Haruskah semuanya masuk dalam README? yaitu pengantar Instalasi Versi Panduan pengguna Penerapan Pengujian Sumber Daya Terkait Atau haruskah Anda memasukkan hal-hal tertentu dalam README (Pendahuluan, Instalasi, Versi) dan informasi lainnya paling baik ditempatkan di wiki Github?

10 documentation  github 

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 

Kami menggunakan metode lincah dalam proyek saya saat ini, dan kami memiliki banyak cerita seperti ini: Sebagai asisten, saya ingin membayar pelanggan pengembalian dana sehingga mereka bisa mendapatkan uang ketika mereka memintanya Sebagai pelanggan, saya ingin membayar pembelian sehingga saya dapat menerima barang saya. Cara kami melakukannya sejauh ini adalah …

10 agile  documentation  requirements  user-story 

Di mana saya saat ini bekerja, pendekatan umumnya adalah - hindari dokumentasi sebanyak mungkin Hanya mendokumentasikan jika tim lain akan membutuhkannya hanya untuk klarifikasi, maksud saya bukan kode-dokumentasi - ini yang kami lakukan, maksud saya semua dokumentasi seputar proses desain - jika itu UML atau DB Schemas, diagram kelas dan …

10 documentation 

Ditutup . Pertanyaan ini perlu lebih fokus . Saat ini tidak menerima jawaban. Ingin meningkatkan pertanyaan ini? Perbarui pertanyaan sehingga berfokus pada satu masalah hanya dengan mengedit posting ini . Ditutup 5 tahun yang lalu . Tim saya saat ini bagian dari pengalaman pergantian yang cukup tinggi, dengan anggota biasanya …

10 documentation  training 

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