search

crashkonijn / GOAP

A multi-threaded GOAP system for Unity
Apache License 2.0
1.1k stars 122 forks source link

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

Open PlatWalker opened 3 months ago

PlatWalker commented 3 months ago

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 commented 3 months ago

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