Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
tonygiang opened this issue May 14, 2021 · 3 comments

Comments

@tonygiang
Copy link
Contributor

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
Copy link
Owner

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
Copy link
Owner

Deadcows commented Jun 2, 2021

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

@Deadcows Deadcows reopened this Jun 2, 2021
@tonygiang
Copy link
Contributor Author

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants