此文件頁面專門針對 Scala 3,可能會涵蓋 Scala 2 中沒有的新概念。除非另有說明,此頁面中的所有程式碼範例都假設您使用 Scala 3。
Scaladoc 提供一個便利的方式,可以在文件的不同版本之間切換。如果我們想要公開舊文件,供尚未遷移到我們函式庫新版本的使用者使用,這個功能會很有用。
如何設定
此功能設計為易於擴充性,無須在新增新版本後重新產生所有 scaladoc。為此,引入了新的設定:-versions-dictionary-url
。其引數必須是 JSON 文件的 URL,其中包含特定版本位置的資訊。JSON 檔案有一個單一屬性 versions
,其中包含將特定文件版本標籤與指向其 index.html 的 URL 關聯的字典。
範例 JSON 檔案
{
"versions": {
"3.0.x": "https://dotty.epfl.ch/3.0.x/docs/index.html",
"Nightly": "https://dotty.epfl.ch/docs/index.html"
}
}
這強制我們在為每個版本產生文件時提供設定,但它在稍後會給予我們更大的彈性。如果您想要在您已發布的 5 個先前版本旁邊新增一個 API 文件版本,則您只需要將新文件上傳到網路伺服器,並在 JSON 檔案中新增一個新項目。網站的所有版本現在都會知道新網站版本。
要注意的重要事項是,只有一個 JSON 檔案可以避免冗餘,而且每個 scaladoc 都必須事先設定其 URL 位置,例如,在 sbt 中
doc / scalacOptions ++= Seq("-versions-dictionary-url", "https://dotty.epfl.ch/versions.json")
它從使用者的角度看起來如何
透過 -versions-dictionary-url
提供 JSON 檔案,可讓 scaladoc 在版本之間建立連結。在下拉式功能表中變更修訂標籤也很方便。所有內容都會自動變更。