Pertanyaan yang diberi tag «documentation»

Mengapa dokumentasi pada beberapa bahasa mengatakan "setara dengan" daripada "adalah"? Sebagai contoh, Python Docs berkata itertools.chain(*iterables) ... Setara dengan: def chain(*iterables): # chain('ABC', 'DEF') --> A B C D E F for it in iterables: for element in it: yield element Atau referensi C ++ ini pada find_if: Perilaku templat …

23 c++  python  documentation  compiler 

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 

Tampaknya sedikit subjek yang kontroversial untuk mendokumentasikan segala sesuatu, termasuk sintaks "JavaBean" getter dan setter untuk bidang: Orang - orang mengatakan bahwa KERING panjang dan berulang-ulang yang tidak perlu (jangan ulangi sendiri) , bahwa konvensi penamaan harus menjelaskan semuanya , dan itu mengacaukan kode / dokumentasi. Terkadang argumen itu berhasil. …

22 documentation 

Saya tidak dapat menghitung berapa kali saya membaca pernyataan dalam uraian 'tes unit adalah sumber dokumentasi yang sangat penting dari kode yang diuji'. Saya tidak menyangkal mereka benar. Tetapi secara pribadi saya belum menemukan diri saya menggunakannya sebagai dokumentasi. Untuk kerangka kerja khas yang saya gunakan, deklarasi metode mendokumentasikan perilaku …

22 unit-testing  documentation 

Kami sedang menulis spesifikasi fungsional dan teknis dalam format dua kolom; kalimat ringkasan dan detail teknis. Detail sering merujuk pada lampiran dengan diagram, desain tata letak dll. Namun saya berjuang dengan apa yang tegang untuk menuliskannya di: Dengan lampau seolah-olah pekerjaan itu dilakukan saya berjuang untuk menunjukkan ekstensi menyoroti pekerjaan …

21 documentation  specifications  writing 

Latar Belakang: Kolaborator saya dan saya sedang menulis artikel untuk jurnal akademik. Dalam perjalanan penelitian kami, kami menulis sebuah program simulasi di Jawa. Kami ingin membuat program simulasi tersedia secara bebas untuk digunakan orang lain. Kami telah memutuskan untuk meng-hosting kode pada repositori GitHub. Agar mudah digunakan orang lain, kami …

20 java  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 

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 . Setelah menghabiskan lebih dari satu tahun bekerja pada proyek jaringan sosial untuk saya …

19 documentation  hiring  outsourcing  knowledge-transfer  wordpress 

Terkadang, meski tidak sering, saya harus memasukkan logika matematika ke dalam kode saya. Konsep yang digunakan sebagian besar sangat sederhana, tetapi kode yang dihasilkan tidak - banyak variabel dengan tujuan yang tidak jelas, dan beberapa operasi dengan maksud yang tidak begitu jelas. Saya tidak berarti bahwa kode tidak dapat dibaca …

19 java  documentation  math 

Baru-baru ini saya telah mengerjakan refactoring bagian-bagian dari basis kode yang saat ini saya tangani - tidak hanya untuk memahaminya dengan lebih baik, tetapi juga untuk membuatnya lebih mudah bagi orang lain yang mengerjakan kode. Saya cenderung bersandar pada sisi berpikir bahwa mendokumentasikan kode sendiri itu bagus . Saya hanya …

18 java  documentation  refactoring  javadocs 

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 5 tahun yang lalu . Semua orang tahu bahwa pengembangan perangkat lunak yang terdokumentasi dengan baik mengarah pada …

18 documentation  wiki 

Asumsikan bahwa Anda adalah satu-satunya pengembang yang meninggalkan pekerjaan. Informasi / materi apa, di luar kode itu sendiri, yang harus Anda buat dan tinggalkan untuk pengganti Anda? Jawaban yang jelas adalah "apa pun yang Anda inginkan di pekerjaan baru" pasti, tetapi sudah lama sejak saya memulai pekerjaan baru, dan saya …

18 documentation  knowledge-transfer 

Saya telah mencari cara mendokumentasikan proyek perangkat lunak secara lebih formal, dan saya telah belajar tentang IEEE 830-1998: Praktik yang Disarankan untuk Spesifikasi Persyaratan Perangkat Lunak . Namun, seperti yang Anda lihat dari tautan itu, tautan tersebut telah digantikan. Saya tahu bahwa 830-1998, dan mungkin bahkan 830-1993, mungkin baik untuk …

17 documentation  requirements  standards 

Kita semua telah melihat banyak contoh perangkat lunak yang dikirimkan dengan "persyaratan sistem minimum" seperti berikut: Windows XP / Vista / 7 RAM 1GB Penyimpanan 200 MB Bagaimana ini umumnya ditentukan? Jelas kadang-kadang ada kendala khusus (jika program membutuhkan 200 MB pada disk maka itu adalah persyaratan yang sulit). Selain …

17 documentation  requirements  qa 

Salah satu devs di tim saya percaya bahwa perlu untuk menulis komentar javadoc untuk setiap parameter dalam tanda tangan metode. Saya tidak berpikir ini perlu, dan bahkan saya pikir itu bisa berbahaya. Pertama, saya pikir nama parameter harus deskriptif dan mendokumentasikan diri. Jika tidak segera jelas untuk apa parameter Anda, …

17 java  documentation  source-code  comments  maintainability