Add documentation for the SDK API methods and types.
Rules for writing the docsstring:
global.ruleset will enforce the stylecop rule SA1600 trough most of the code. For some service implementations, like LootboxService that only implements ILootboxService, we should just add #pragma warning disable SA1600 to the top of the .cs file. If you want to restore the rules you should do the #pragma warning restore SA1600
Things that must have docsstring:
- class definition (what it is, what it does)
- public properties
- public methods
- public events and delegates
private things are not needed to have comments. Add them if they're essential to some of the public identifiers listed above.
Add documentation for the SDK API methods and types.
Rules for writing the docsstring:
global.ruleset will enforce the stylecop rule SA1600 trough most of the code. For some service implementations, like LootboxService that only implements ILootboxService, we should just add #pragma warning disable SA1600 to the top of the .cs file. If you want to restore the rules you should do the #pragma warning restore SA1600
Things that must have docsstring:
private things are not needed to have comments. Add them if they're essential to some of the public identifiers listed above.