Dokumentasi perangkat lunak adalah teks tertulis yang menyertai perangkat lunak komputer. Ini menjelaskan bagaimana perangkat lunak beroperasi, bagaimana cara menginstalnya, bagaimana menggunakannya, dan sumber daya lainnya untuk bantuan.
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...
Saya telah secara khusus diminta untuk memberikan penjelasan atau komentar per baris (atau yang sesuai - misalnya, gambar per gambar, dll.) Yang ingin dibaca dan diikuti oleh bos saya. Karena dia bukan seorang programmer, dia tidak bisa mengikuti kode sehingga ingin semuanya diterjemahkan ke...
RFC 2606 standar mencadangkan nama domain example.org , example.net dan example.com untuk tujuan digunakan sebagai contoh dalam dokumentasi. Apa yang setara dengan nomor telepon (termasuk kode negara) yang dapat digunakan sebagai contoh, misalnya untuk memberikan contoh kepada pengguna dalam...
Misalkan saya sedang mengembangkan proyek yang relatif besar. Saya sudah mendokumentasikan semua kelas dan fungsi saya dengan Doxygen, namun, saya punya ide untuk meletakkan "catatan programmer" pada setiap file kode sumber. Gagasan di balik ini adalah untuk menjelaskan dalam istilah awam...
Selama pertemuan mengenai kemunduran SDK pihak ketiga dari versi terbaru, dicatat bahwa pengembang kami telah menandai dalam komit sejarah bahwa versi terbaru tidak boleh digunakan. Beberapa pengembang berpendapat bahwa ini adalah praktik yang buruk dan seharusnya dicatat dalam file sumber (yaitu...
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...
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());
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...
Saya mengerjakan sebuah proyek tiga bulan lalu, dan kemudian tiba-tiba proyek mendesak lainnya muncul dan saya diminta untuk mengalihkan perhatian saya. Mulai besok, saya akan kembali ke proyek lama. Saya menyadari bahwa saya tidak ingat apa yang sebenarnya saya lakukan. Saya tidak tahu harus...
Saya berencana meninggalkan pekerjaan saya saat ini karena kami terkunci dalam menggunakan Blub , dengan kerangka kerja perusahaan Blub dan server web tingkat-Blub, pada hosting bersama yang biasa-biasa saja. Rekan kerja saya ramah dan bos saya rata-rata pemilik usaha kecil - saya ingin pergi...
Saya mengerti pentingnya kode yang terdokumentasi dengan baik. Tetapi saya juga memahami pentingnya kode dokumentasi diri . Semakin mudah membaca fungsi tertentu secara visual, semakin cepat kita dapat melanjutkan selama pemeliharaan perangkat lunak. Dengan itu, saya suka memisahkan fungsi besar...
Pembuatan dokumentasi otomatis dapat dilakukan dengan berbagai alat, GhostDoc menjadi salah satu yang lebih menonjol. Namun, menurut definisi, semua yang dihasilkannya berlebihan. Dibutuhkan melihat nama-nama metode, kelas, dll dan keluaran bahasa Inggris yang mungkin menjelaskannya lebih jelas....
Saya menulis dokumentasi pengguna (SOP) yang melibatkan program pihak ketiga yang saya coba gambarkan dengan baik. Salah satu program tersebut adalah server yang menawarkan sedikit indikasi startup itu selain grafik yang menunjukkan selama rutin inisialisasi / startup. Sebagai pengembang, saya...
Kadang-kadang saya menemukan diri saya dalam situasi ketika bagian dari kode yang saya tulis adalah (atau tampaknya ) sangat jelas sehingga namanya pada dasarnya akan diulang sebagai komentar: class Example { /// <summary> /// The location of the update. /// </summary> public Uri...
Ketika Anda menggunakan alat-alat seperti jsdocs , itu menghasilkan file HTML statis dan gayanya di basis kode Anda berdasarkan komentar dalam kode Anda. Haruskah file-file ini diperiksa ke dalam repositori Git atau haruskah mereka diabaikan dengan
Salah satu tujuan utama perusahaan pengembang perangkat lunak adalah untuk meningkatkan faktor Bus mereka. Hal ini juga dianjurkan dalam ceramah yang diselenggarakan oleh Google . Itu berarti Anda harus membuat kode dan mendokumentasikan segala sesuatu dengan cara sehingga jika Anda ditabrak bus...
Tampaknya ada keengganan untuk menulis bahkan dokumentasi paling dasar. README proyek kami relatif telanjang. Bahkan tidak ada daftar dependensi yang diperbarui dalam dokumen. Adakah sesuatu yang tidak saya sadari dalam industri yang membuat programmer tidak suka menulis dokumentasi? Saya bisa...
Ketika mengerjakan kode, saya menghadapi banyak tantangan yang sama seperti yang dilakukan rekan tim saya, dan saya telah menulis beberapa fungsi dan kelas yang membantu, dan begitu juga mereka. Jika ada komunikasi yang baik, saya akan mendengar tentang beberapa hal hebat yang disatukan seseorang,...
Saya menemukan diri saya menulis (semoga) komentar bermanfaat dalam kode (C ++) jenis dokumentasi: The reason we are doing this is... Alasan saya menggunakan "kita" daripada "saya" adalah karena saya melakukan banyak penulisan akademis di mana "kita" sering lebih disukai. Jadi, inilah...
Program CS sekolah saya menghindari penyebutan pemrograman berorientasi objek, jadi saya telah melakukan beberapa bacaan sendiri untuk menambahnya - khususnya, Konstruksi Perangkat Lunak Berorientasi Objek oleh Bertrand Meyer. Meyer berulang kali menekankan bahwa kelas harus menyembunyikan...