Saya orang ilmiah yang perlu mendokumentasikan kode Matlab yang kompleks untuk diserahkan kepada pengembang agar dia mengerti dan memprogram dalam bahasa yang berbeda. Di masa lalu, saya telah menggunakan MS Word (menjelaskan setiap langkah program sebagai baris baru dalam sebuah tabel), dan kemudian Excel, tetapi tidak menemukan yang sangat cocok untuk menampilkan kode Matlab saya dan memasukkan komentar secara jelas dan ringkas. cara mendokumentasikannya.
Saya ingin tahu apakah ada teknik yang lebih baik untuk mengkomunikasikan kode semu kepada pengembang. Adakah perangkat lunak yang ada (gratis?) Atau platform lain (mis. TextWrangler) sangat cocok untuk menyediakan kode dan beberapa metode untuk menjelaskannya? Berharap untuk belajar dari pengalaman orang lain melakukan hal yang sama. Terima kasih sebelumnya.
Setelah membaca beberapa komentar, izinkan saya mencoba menjelaskan lebih lanjut ... Saya menganggap semua pengembang tahu pseudo-code, tapi saya tidak berasumsi banyak yang tahu kode Matlab. Jadi, jika saya menulis dalam pseudo-code, saya dapat mengabaikan kode Matlab (atau memberikannya untuk referensi, dll.). Tetapi pertanyaan saya sangat sederhana ... apakah ada perangkat lunak atau platform yang digunakan orang di masa lalu untuk mengkomunikasikan kode dengan jelas kepada pengembang? Sesuatu yang memungkinkan orang membuat dokumen dengan mudah menggambarkan kode? Misalnya, Anda dapat menanamkan kode warna kode perangkat lunak (satu warna untuk komentar, satu lagi untuk kata-kata yang dicadangkan (jika, kemudian, yang lain, untuk, dll.), Dll.), Dan di satu sisi ada ruang bagi saya untuk memasukkan penjelasan dan referensi, dll. Saya mencoba melakukan ini menggunakan produk MS, tetapi berpikir karena ada industri orang yang perlu melakukan hal yang sama,
%
memulai komentar, dan kemudian saya ingin komentar jelas ditambahkan ke kode Matlab. Dan izinkan saya kembali dengan pertanyaan tentang hal-hal yang tidak masuk akal bagi saya. Itu akan menjadi yang paling mudah di sekitar.