Deadcows / MyBox

MyBox is a set of attributes, tools and extensions for Unity
http://deadcow.ru
MIT License
1.91k stars 241 forks source link

Add instruction to enable self-documentation of extension methods on Intellisense in the wiki #145

Open tonygiang opened 3 years ago

tonygiang commented 3 years ago

My colleagues find it unclear to tell what MyBox's extension methods actually do, and when they go to the documentation, it's not much help either. I understand that extension documentation is still a while away, but I thought: with very few lines added, the wiki page for Extensions can instruct users to enable self-documentation in Intellisense, since Unity does not do this by default. I propose something like this appended to the current Extensions wiki page:

In the mean time, you can enable Intellisense to display self-documentation of these methods by following these steps: In Unity Editor, open Edit > Preferences > External Tools and enable "Generate .csproj files for" Registry packages and Git packages, then click "Regenerate project files". The next time you open Visual Studio, Intellisense will show you comments for MyBox's extension methods.

Deadcows commented 3 years ago

Oh, I didn't knew that methods descriptions are not visible by default! I added this info to Installation guide as well as well

Deadcows commented 3 years ago

It might be possible to check and toggle this values automatically via reflection...

Interesting thing to investigate 😁

some links for a future me: Plase where settings drawn Settings get and set .csproj regeneration button SyncVS class here and here And to check this function

tonygiang commented 3 years ago

This was actually an issue that was raised over at Unity Forum, which I chimed in to support for an engine-level fix. But seeing how this is very low on the critical scale for Unity, we'll just have to pass around awareness of this workaround.