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

Feature: Add Xml comment's for public methods and properties #169

Open
PlatWalker opened this issue Jun 1, 2024 · 2 comments
Open

Feature: Add Xml comment's for public methods and properties #169

PlatWalker opened this issue Jun 1, 2024 · 2 comments

Comments

@PlatWalker
Copy link

PlatWalker commented Jun 1, 2024

Kinda straightforwad. Can you add xml comments to public methods and properties? It's so much easier to just browse code and look up what things doing and not trying to find this one sentence in yours (very nicly done, by the way) documentation? Here is example:

public void SetGoal<TGoal>(bool endAction) where TGoal : IGoalBase { this.SetGoal(this.GoapSet.ResolveGoal<TGoal>(), endAction); }
What is this bool with endAction? I would need to refer to some place in documentation and it could be just a nice xml

/// <summary> /// Set's goal for agent. /// </summary> /// <param name="endAction">does this and this</param>

so goooooood quality of life update it would be, with a little effort!

@laurentopia
Copy link

/// <summary> & /// </summary> are not needed
triple dash is enough to trigger display of comment in IDEs

@sima995
Copy link

sima995 commented Nov 15, 2024

This would indeed be nice. It would mean we don't have to go back and forth looking at the code and trying to find the part in the docs that explains it which is a bit frustrating right now.

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

No branches or pull requests

3 participants