Bagian inti dari Desain Berbasis Domain adalah penggunaan yang konsisten dari bahasa di mana-mana di seluruh sistem - dalam percakapan, kode, skema basis data, UI, tes, dll. Saya terlibat dalam sebuah proyek di mana sudah ada bahasa domain yang sudah mapan, yang ditentukan oleh organisasi standar...
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...
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...
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 -...
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...
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...
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...
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 telah mendokumentasikan kode saya untuk doxygen, tetapi saya tidak ingin HTML default yang diberikannya. Saya tahu saya dapat menyesuaikannya dengan memberikan CSS khusus, header, footer, dll. (Seperti yang dilakukan GNOME), dan bagaimana saya dapat menambahkan kode PHP umum ke file dan...
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...
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 seorang pengembang perangkat lunak di sebuah perusahaan teknologi. Saya telah ditugaskan memimpin upaya dokumentasi untuk produk yang saya kerjakan. Tujuannya adalah untuk menghasilkan dokumentasi internal untuk pengembang, dan proyek mengalir ke sisi bisnis, di mana mencakup dokumentasi...
Jadi Anda memperbaiki bug, maka Anda menemukan satu yang dapat mempengaruhi modul lain dari produk perangkat lunak. Data Anda tidak cukup untuk mendukung klaim Anda tentang efek perbaikan dan Anda diminta untuk membuat dokumen analisis dampak. Apakah ada proses yang pasti tentang bagaimana...
Adakah yang punya saran untuk membuat diagram alur dari antarmuka web gaya REST? Untuk kepentingan menyediakan dokumentasi menyeluruh kepada pengembang bersama, saya telah mempermainkan antarmuka model untuk memodifikasi dan menghasilkan sumber daya produk: Sistem khusus ini mulai bertindak...
Seringkali saya menemukan diri saya memecahkan bug dengan menemukan jawabannya di Stack Overflow. Apakah praktik yang buruk untuk menambahkan cuplikan mengapa saya melakukan apa yang saya lakukan dan kemudian menambahkan tautan ke artikel atau halaman dari
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
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,...
Ini merujuk pada diskusi dalam jawaban dan komentar dari pertanyaan ini: Ada apa dengan keengganan dokumentasi di industri? . Jawabannya mengklaim bahwa "kode tidak bisa berbohong" dan karenanya harus menjadi lokasi masuk bukan dokumentasi. Beberapa komentar menunjukkan bahwa "kode bisa berbohong"....
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 4 tahun yang lalu . Mengapa kita masih...
Ketika meninjau implementasi programmer lain dari fungsi untuk menghitung distribusi CDF normal , saya membuat saran untuk mengganti seluruh implementasi dengan fungsi bawaan Python atau menggunakan SciPy, perpustakaan ilmiah umum. Programmer lain menunjukkan bahwa keduanya math.erfc()tidak...