Menggunakan Haxedoc untuk menghasilkan dokumentasi untuk proyek saya

Saya menulis api game html5 saya dengan haxe dan sekarang saya ingin membuat dokumentasi secara otomatis dari komentar di kode. Namun, saya tidak tahu bagaimana memulainya. Saya ingin mencoba menggunakan haxedoc tetapi satu-satunya dokumentasi yang saya miliki ada di situs web ini dan tidak terlalu membantu sama sekali: http://haxe.org/doc/haxedoc

Ketika saya menjalankan perintah ini: haxe -xml output.xml build.hxml

katanya build.hxml tidak ada.

Bagaimana cara agar haxedoc menjalankan proyek saya dan menghasilkan dokumentasi? Langkah-langkah spesifik sangat dihargai.


documentation haxe
person user1261710    schedule 19.02.2014    source sumber

Jawaban (1)


arrow_upward
1
arrow_downward

Anda dapat membuat .hxml untuk digunakan sebagai dokumentasi. Cara membuat .hxml didokumentasikan di sini http://haxe.org/doc/compiler#example

person Mark Knol    schedule 19.02.2014
comment
Apakah Anda harus membuat file hxml? Ini sangat membosankan untuk jumlah file yang saya miliki. - person user1261710; 20.02.2014
comment
File hxml hanya berisi instruksi bagaimana membangun proyek, yang diperlukan untuk dokumentasi. Jadi ya saya pikir itu diperlukan. - person Mark Knol; 20.02.2014
comment
Masalahnya adalah saya hanya ingin mendokumentasikan kerangka kerja dan bukan gamenya sehingga game itu sendiri memiliki file build tetapi bukan kerangkanya. Saya tidak pernah membangun kerangka kerja sendirian jadi menurut saya ini aneh. Frameworknya tidak berjalan dengan sendirinya jadi saya masih perlu membuat file ini. - person user1261710; 20.02.2014
comment
Saya pikir ini masuk akal, Anda ingin dokumen kerangka kerja, maka Anda perlu membangun kerangka kerja sepenuhnya. Kalau tidak, Anda juga mendapatkan kelas terkait proyek di dalamnya. Targetnya seperti apa? Saya dapat membuat hxml sederhana untuk Anda, mungkin berisi 4 baris instruksi. - person Mark Knol; 20.02.2014