Unity的Package库在IDE里不显示API注释的解决方法
  VzZBtB0KXYfE 2024年08月07日 63 0

当你在代码里使用Package库的API的时候,比如Addressable和Unity.Entities等等,以Visual Studio为例,鼠标放到API上,会发现不显示注释:

然而按F12访问源代码,会发现代码里面是有注释的,而且Unity自己的包注释会非常的详细(Unity的API文档就是直接从这些注释生成的):

本质原因是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,或者跑到网页上看文档了。

【版权声明】本文内容来自摩杜云社区用户原创、第三方投稿、转载,内容版权归原作者所有。本网站的目的在于传递更多信息,不拥有版权,亦不承担相应法律责任。如果您发现本社区中有涉嫌抄袭的内容,欢迎发送邮件进行举报,并提供相关证据,一经查实,本社区将立刻删除涉嫌侵权内容,举报邮箱: cloudbbs@moduyun.com

  1. 分享:
最后一次编辑于 2024年08月07日 0

暂无评论

推荐阅读
  1wMBnbixARwC   2024年08月07日   57   0   0 游戏开发
  NiD7Hlfm86HK   2024年08月07日   55   0   0 游戏开发
  vWa2lMmTbsfJ   2024年08月07日   101   0   0 游戏开发
  PfEVswrG0sbF   2024年08月07日   51   0   0 游戏开发
  1wMBnbixARwC   2024年08月07日   62   0   0 游戏开发
VzZBtB0KXYfE