微軟宣布套件作者現在可以將README.md檔案,打包進NuGet套件中,README內容就能被完整呈現在NuGet.org上,官方提到,這項功能還在預覽階段,想要快速嘗試這個功能,可以安裝最新的.NET 6或是Visual Studio預覽版本。

微軟在前些時日,對NuGet社群進行調查,微軟發現最大的問題,是大多數套件的文件無法從NuGet.org簡單取用,有45%的調查受訪者認為,需要的重要套件在NuGet.org上都存在,但是缺乏良好的文件說明,以至於對NuGet生態系感到不滿意。

過去微軟在NuGet.org上提供Markdown文件支援,但是這要求作者要在NuGet.org上,對每個新的套件版本,都貼上README或是README連結,這個程序對作者來說太過麻煩,而現在微軟改進README的處理體驗,作者能以處理圖標或是授權等其他嵌入式套件檔案的方式,來處理README.md檔案。

作者不用特地到NuGet.org,可以使用熟悉的NuGet套件工具新增說明文件,而作者一旦在專案檔案中加入README.md路徑,則最新的README檔案便會每次都被打包進套件,也就是說作者現在只需要設定一次,之後就不再麻煩。README是不可變更,而且專屬於特定版本,因此套件使用者也可以查看其他舊版套件中README。

套件作者可以預覽README文件,只要使用NuGet.org上傳網頁入口網站上傳套件,就可以從網頁下方元資料區塊預覽README文件,想要修正套件的README文件,作者必須推送套件更新版本。微軟建議作者,可以花一些時間查看和預覽README文件,確保圖像和格式符合要求,藉此讓使用者留下深刻印象。


熱門新聞

Advertisement