Pertanyaan yang diberi tag «documentation-generation»

Pengembangan Behavior-Driven dengan simbol skenario "Given-When-Then" simbolik akhir-akhir ini cukup populer karena kemungkinan penggunaannya sebagai objek batas untuk penilaian fungsionalitas perangkat lunak. Saya pasti setuju bahwa Gherkin , atau skrip definisi fitur mana pun yang Anda inginkan, adalah DSL yang dapat dibaca oleh bisnis , dan sudah memberikan nilai seperti …

24 documentation  bdd  documentation-generation  business-rules 

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 tahun lalu . Saya ingin mendokumentasikan kode saya sehingga ada kebutuhan minimum untuk membaca dan menelusuri kode lagi beberapa …

22 documentation  code-reviews  documentation-generation  help-documentation 

Jadi kami memiliki antarmuka seperti itu /// <summary> /// Interface for classes capable of creating foos /// </summary> public interface ICreatesFoo { /// <summary> /// Creates foos /// </summary> void Create(Foo foo); /// <summary> /// Does Bar stuff /// </summary> void Bar(); } Baru-baru ini, kami memainkan cerita dokumentasi yang …

20 c#  documentation  xml  documentation-generation 

Saat ini saya menggunakan dua sistem untuk menulis dokumentasi kode (saya menggunakan C ++): Dokumentasi tentang metode dan anggota kelas ditambahkan di sebelah kode, menggunakan format Doxygen. Di server, Doxygen dijalankan pada sumber sehingga hasilnya dapat dilihat di browser web Halaman ikhtisar (menggambarkan sekumpulan kelas, struktur aplikasi, contoh kode, ...) …

13 documentation  documentation-generation  wiki 

Apakah ada istilah yang baik yang serupa tetapi berbeda dari "mencela" yang berarti bahwa metode atau API ada dalam basis kode tetapi tidak boleh digunakan karena implementasinya tidak lengkap atau kemungkinan akan berubah? (Ya, aku tahu, metode-metode itu seharusnya tidak bersifat publik, yada yada yada. Aku tidak menciptakan situasiku, aku …

12 documentation  terminology  api  documentation-generation  javadocs 

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 . Saya telah menyelesaikan aplikasi web yang pada dasarnya dikembangkan dalam PHP dan hanyalah aplikasi …

11 project-management  documentation  documentation-generation  projects-and-solutions 

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 menyuruhnya menyimpannya .php, tetapi itu bukan yang saya …

10 documentation  templates  documentation-generation