ford

福特

這是現代福特程序的自動文檔生成器。福特代表Fortran紀錄片。如您所知，“福特”是指越過河（或其他水域）。在這種情況下，它並不是指任何與汽車相關的公司或個人。

由於Doxygen對Fortran的處理不佳以及缺乏可比的替代方案，福特之所以撰寫。 RoboDoc實際上無法從源代碼中提取任何信息，我發現的幾乎任何其他自動文檔軟件都是專有的，對於Fortran來說不是很好，或者在其產生如何產生的方面受到限制。 F90DOC非常好，我設法修改了它，以便它可以處理大多數Fortran 2003，但是它會產生相當醜陋的文檔，無法與文檔的不同部分之間提供盡可能多的鏈接，並且用Perl編寫（我不太熟悉，並且在Python中不太熟悉，並且在Python中發現了用於生產HTML內容的那種圖書館）。

福特的目的是能夠可靠地為現代Fortran軟件製作文檔，這是信息豐富且愉快的文檔。該文檔應易於編寫和在代碼中不可撰寫。雖然它永遠不會像Doxygen那樣豐富功能，但希望福特能夠為記錄Fortran項目提供一個很好的替代方法。

功能

當前功能包括：

• 從源代碼中提取有關變量，過程，過程參數，派生類型，程序和模塊的信息的能力。
• 從源代碼中的註釋中提取文檔的能力。
• 使用Mathjax的文檔中的乳膠支持。
• 可搜索的文檔，使用LUNR搜索。
• 作者描述和社交媒體（包括github！）鏈接。
• 鏈接以下載源代碼。
• 鏈接到單個文件的鏈接，無論是其原始形式還是在HTML中進行語法突出顯示。
• 將降價用於類型存儲文檔。
• 軟件相關部分之間的鏈接。
• Bootstrap CSS用於文檔，使其既有功能又漂亮。
• 可配置的設置。
• 能夠創建包含一般信息的層次結構集，而與源代碼的任何特定部分無關。
• 顯示具有文件級文檔和語法突出顯示代碼的非Fortran源文件的條目。

安裝

安裝福特的最簡單方法是使用PIP：

 pip install ford

PIP將自動為您處理所有依賴關係。默認情況下，這將把ford放在~/.local/bin中 - 您可能需要將其添加到PATH中。

另外，可以通過Mac OS X的Homebrew Package Manager獲得福特。要更新Homebrew並安裝福特，請在終端中運行這些命令：

 brew update
brew install FORD

如果brew install --HEAD FORD想從GitHub安裝最新的開發項目（Master --HEAD分支

通過運行以下命令，也可以通過SPACK軟件包管理器獲得福特：

 spack install py-ford

文件

更完整的文檔可以在文檔中找到。

執照

該程序是免費的軟件：您可以根據自由軟件基金會發布的GNU通用公共許可證的條款對其進行重新分配和/或修改它，該版本是該許可證的版本3，或（按您的選項）任何以後的版本。

該程序的分佈是希望它將有用的，但沒有任何保證；即使沒有對特定目的的適銷性或適合性的隱含保證。有關更多詳細信息，請參見GNU通用公共許可證。

您應該已經收到了GNU通用公共許可證的副本以及此計劃。如果沒有，請參見GNU網站。

福特生產的文件是從其生產中使用的輸入得出的衍生作品；他們不受此許可的影響。