Skip to content

Instantly share code, notes, and snippets.

@lordcodes
Created November 20, 2016 18:26
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save lordcodes/ae4e98ed1de1610f8bac692ce6201998 to your computer and use it in GitHub Desktop.
Save lordcodes/ae4e98ed1de1610f8bac692ce6201998 to your computer and use it in GitHub Desktop.
How to document a method within your C# library's public API
namespace YourNamespace {
/// <summary>
/// Put a description of the class here.
/// </summary>
public class YourClass {
/// <summary>
/// Put a description of the method here.
/// </summary>
/// <param name="key">Put a description of the parameter here.</param>
/// <param name="defaultValue">Put a description of the other parameter here.</param>
/// <returns>Put a description of the returned value here.</returns>
public bool Get(string key, bool defaultValue = default(bool)) {
return data.Get(key, defaultValue);
}
}
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment