You're right. You've helped me. But I don't understand why a.csproj file needs to be generated to parse xml comments. After all, the xml comment already exists; we just read it and convert it to another format for display. For example, vs2022 allows you to parse xml comments without having to generate a.csproj file for your project.
But I don't understand why a.csproj file needs to be generated to parse xml comments. After all, the xml comment already exists; we just read it and convert it to another format for display.
Packages are compiled into assemblies and added as binary references. Since the source code isn't part of the solution, Rider doesn't index it, and so doesn't see or index the XML doc blocks. When you generate project files for packages, Rider indexes the source, sees the XML doc blocks and thus can show XML documentation. Rider can do quite a lot with the source code of packages, but that's thanks to PDB information from the compiled assembly - it gives Rider nearly everything we need for navigation, etc. Rider also shows it in the Unity Explorer, so you can browse to it as well as navigate to it. But unless the compiler generates XML documentation when it builds the packages, then Rider can't show anything.
I hope the above clears it up.
For example, vs2022 allows you to parse xml comments without having to generate a.csproj file for your project.
In theory, Visual Studio has the same limitations here. Could you please clarify whether you have taken any additional configuration steps to get it working this way in VS?
In theory, Visual Studio has the same limitations here. Could you please clarify whether you have taken any additional configuration steps to get it working this way in VS?
I did the following: 1. Disable all plugins for VS2022. 2. Set "External Script Editor" to VS2022. 3. Uncheck all options in Unity's "Generate.csproj files for:". And click "Regenerate project files". 4. Close unity and VS2022. 5. Manually delete all csproj files in the project. 6. Restart unity and vs2022. 7. The XML comments will still parse properly at the method of the external source of the decompiled dll.
I don't know if I did anything special for VS2022, but it's probably not a plugin effect.
Thank you. Your answer cleared my confusion. Now I was able to view the comments normally by setting to generate.csproj.
Hello,
Do you have project files generated for the packages in the project (see Unity Settings | External Tools | Generate .csproj files for)?
Hi, Ivan Skorikov
You're right. You've helped me. But I don't understand why a.csproj file needs to be generated to parse xml comments. After all, the xml comment already exists; we just read it and convert it to another format for display. For example, vs2022 allows you to parse xml comments without having to generate a.csproj file for your project.
Thank you.
Hello,
Packages are compiled into assemblies and added as binary references. Since the source code isn't part of the solution, Rider doesn't index it, and so doesn't see or index the XML doc blocks. When you generate project files for packages, Rider indexes the source, sees the XML doc blocks and thus can show XML documentation.
Rider can do quite a lot with the source code of packages, but that's thanks to PDB information from the compiled assembly - it gives Rider nearly everything we need for navigation, etc. Rider also shows it in the Unity Explorer, so you can browse to it as well as navigate to it.
But unless the compiler generates XML documentation when it builds the packages, then Rider can't show anything.
I hope the above clears it up.
In theory, Visual Studio has the same limitations here. Could you please clarify whether you have taken any additional configuration steps to get it working this way in VS?
Hi, Ivan Skorikov
Sorry, I just saw the news.
I did the following:
1. Disable all plugins for VS2022.
2. Set "External Script Editor" to VS2022.
3. Uncheck all options in Unity's "Generate.csproj files for:". And click "Regenerate project files".
4. Close unity and VS2022.
5. Manually delete all csproj files in the project.
6. Restart unity and vs2022.
7. The XML comments will still parse properly at the method of the external source of the decompiled dll.
I don't know if I did anything special for VS2022, but it's probably not a plugin effect.
Thank you. Your answer cleared my confusion. Now I was able to view the comments normally by setting to generate.csproj.