AlexanderColen / Annie-May-Discord-Bot

Discord bot written in C# for AniList anime/manga lookup.
https://discord.com/oauth2/authorize?client_id=701143398526222386&permissions=388160&scope=bot
13 stars 1 forks source link

Write summaries and comments explaining the code. #16

Closed AlexanderColen closed 4 years ago

AlexanderColen commented 4 years ago

Clear and concise one-liners as summary description and map out all the parameters and return values.

Might want to get rid of: [Summary("This is a simple method summary.")] and replace with:

/// <summary>
/// This is a more descriptive method summary.
/// </summary>
/// <param name="aParameter">I am the method parameter.</param>
/// <returns>I am the return value.</returns>

Make sure that every method is at least covered by a summary, ideally add comments within code with reasons for a loop, if, and return statement.

AlexanderColen commented 4 years ago

Turns out Summary is a Discord.NET object that is used for automatically generating a help command. (See: https://stackoverflow.com/a/52856282)

Seems to be worth keeping both the Summary objects and adding /// summary for modules.