ford
v7.0.9
นี่คือเครื่องกำเนิดเอกสารอัตโนมัติสำหรับโปรแกรม Fortran สมัยใหม่ ฟอร์ดย่อมาจาก Fortran Documenter อย่างที่คุณอาจรู้ว่า "ถึงฟอร์ด" หมายถึงการข้ามแม่น้ำ (หรือแหล่งน้ำอื่น ๆ ) ในบริบทนี้ไม่ได้อ้างถึง บริษัท หรือบุคคลใด ๆ ที่เกี่ยวข้องกับรถยนต์
ฟอร์ดถูกเขียนขึ้นเนื่องจากการจัดการ Fortran ที่ไม่ดีของ Doxygen และการขาดทางเลือกที่เทียบเคียงได้ Robodoc ไม่สามารถแยกข้อมูลใด ๆ ออกจากซอร์สโค้ดและซอฟต์แวร์เอกสารอัตโนมัติอื่น ๆ ที่ฉันพบว่าเป็นกรรมสิทธิ์ไม่ได้ทำงานได้ดีสำหรับ Fortran หรือถูก จำกัด ในแง่ของวิธีการผลิตผลผลิต F90DOC ค่อนข้างดีและฉันสามารถปรับเปลี่ยนได้เพื่อให้สามารถจัดการกับ Fortran 2003 ส่วนใหญ่ได้ แต่มันสร้างเอกสารที่ค่อนข้างน่าเกลียดไม่สามารถให้การเชื่อมโยงระหว่างส่วนต่าง ๆ ของเอกสารที่ฉันต้องการและเขียนไว้ใน Perl (ซึ่งฉันไม่คุ้นเคย
เป้าหมายของฟอร์ดคือการสามารถสร้างเอกสารประกอบสำหรับซอฟต์แวร์ Fortran สมัยใหม่ซึ่งให้ข้อมูลและดูดี เอกสารควรจะง่ายต่อการเขียนและไม่ขัดขวางภายในรหัส แม้ว่ามันจะไม่ได้มีคุณสมบัติที่อุดมไปด้วย Doxygen หวังว่าฟอร์ดจะสามารถเป็นทางเลือกที่ดีสำหรับการจัดทำเอกสารโครงการ Fortran
คุณสมบัติปัจจุบัน ได้แก่ :
วิธีที่ง่ายที่สุดในการติดตั้งฟอร์ดคือการใช้ PIP:
pip install ford
PIP จะจัดการกับการพึ่งพาทั้งหมดสำหรับคุณโดยอัตโนมัติ โดยค่าเริ่มต้นสิ่งนี้จะวาง ford ใน ~/.local/bin - คุณอาจต้องเพิ่มสิ่งนี้ลงใน PATH ของคุณ
อีกทางเลือกหนึ่งฟอร์ดมีให้บริการผ่าน HomeBrew Package Manager สำหรับ Mac OS X เพื่ออัปเดต Homebrew และติดตั้ง Ford ให้เรียกใช้คำสั่งเหล่านี้ในเทอร์มินัล:
brew update
brew install FORD
หากคุณต้องการติดตั้งสาขาการพัฒนาล่าสุด (Master) จาก GitHub เพียงเพิ่ม --HEAD Flag: brew install --HEAD FORD
ฟอร์ดยังมีให้ผ่าน Spack Package Manager โดยเรียกใช้คำสั่งต่อไปนี้:
spack install py-ford
เอกสารที่สมบูรณ์ยิ่งขึ้นสามารถพบได้ในเอกสาร
โปรแกรมนี้เป็นซอฟต์แวร์ฟรี: คุณสามารถแจกจ่ายใหม่และ/หรือแก้ไขภายใต้ข้อกำหนดของใบอนุญาตสาธารณะ GNU ทั่วไปที่เผยแพร่โดย Free Software Foundation ไม่ว่าจะเป็นเวอร์ชัน 3 ของใบอนุญาตหรือ (ตามตัวเลือกของคุณ) รุ่นใหม่ ๆ
โปรแกรมนี้มีการแจกจ่ายด้วยความหวังว่ามันจะมีประโยชน์ แต่ ไม่มีการโต้แย้งใด ๆ โดยไม่มีการรับประกันโดยนัยเกี่ยวกับ ความสามารถในการค้า หรือ ความเหมาะสมสำหรับวัตถุประสงค์เฉพาะ ดูใบอนุญาตสาธารณะ GNU ทั่วไปสำหรับรายละเอียดเพิ่มเติม
คุณควรได้รับสำเนาใบอนุญาตสาธารณะ GNU ทั่วไปพร้อมกับโปรแกรมนี้ ถ้าไม่ดูเว็บไซต์ GNU
เอกสารที่ผลิตโดยฟอร์ดเป็นงานอนุพันธ์ที่ได้มาจากอินพุตที่ใช้ในการผลิต พวกเขาไม่ได้รับผลกระทบจากใบอนุญาตนี้
