Unity的Package庫在IDE裡不顯示API註釋的解決方法

horeaper發表於2024-07-03

當你在程式碼裡使用Package庫的API的時候,比如Addressable和Unity.Entities等等,以Visual Studio為例,滑鼠放到API上,會發現不顯示註釋:

然而按F12訪問原始碼,會發現程式碼裡面是有註釋的,而且對於Unity的包,註釋會非常的詳細:

本質原因是Unity在編譯這些Package的時候,沒有生成XML註釋文件,導致IDE找不到註釋。而VS的Unity外掛也沒有智慧到自動把註釋定向到原始檔那邊去。

解決方法也不復雜。以Unity.Entities為例,首先建立一個資料夾,就叫Unity.Entities好了。
然後在裡面建立一個Assembly Definition Reference。在Unity 6裡,選單項的位置如圖所示:

給它起一個名字,比如Unity.Entities.Ref。然後在其Assembly Definition選中Unity.Entities,之後點選Apply:

如果只建立了這麼一個Assembly Definition Reference,Unity有可能不會生成相應的Project檔案。此時可以繼續在資料夾裡建立一個Script,隨便起個名字,比如UnityEntitiesDummyScript,然後放著不管即可。

之後回到IDE內,再去把滑鼠指向Unity.Entities裡的東西,註釋就完美的顯示出來了:

我的註釋框會這麼華麗是因為裝了Resharper的Enhanced Tooltip外掛。

用以上方法,就可以把你想檢視程式碼註釋的Package都新增進來。比如Unity.Entities、Unity.Physics、Unity.NetCode等大部頭。這樣就不用總是按F12,或者跑到網頁上看文件了。

相關文章