Feature: `ParameterSummary` above the method
See original GitHub issueHello everyone,
I am not sure if this is possible but what if there is a way to add the current summary now used for parameters, to be placed above the method? When having multiple parameters in a commands it can become very messy in my opinion.
What if there is a way to use the parameter summary above the method? Like this:
namespace Example;
public class ExampleClass : InteractionModuleBase<SocketInteractionContext>
{
[SlashCommand("say", "Let the bot say something")]
[ParameterSummary("echo", "Give some text the bot will say for u")]
public async Task HandleCommandAsync(string echo) => await RespondAsync(echo);
}
Issue Analytics
- State:
- Created a year ago
- Comments:12 (9 by maintainers)
Top Results From Across the Web
how do I add parameter comments for a method in c# - ...
7 Answers. the "feature" is called XML comments. Just type /// right before your methods and VS will generate some xml tags. These...
Read more >Recommended XML tags for C# documentation comments
This article provides the syntax and definitions for recommended tags for XML documentation.
Read more >Parameter Information | ReSharper Documentation
Whenever you are writing or studying a function call, ReSharper helps you view details on the allowed arguments for all overloads of the ......
Read more >Defining Methods - Learning the Java Language
Overloading Methods This means that methods within a class can have the same name if they have different parameter lists (there are some...
Read more >Documenting C++ Code - LSST DM Developer Guide
The Function/Method Parameters and Returns sections are the best places to describe specific input and output variables. The Notes section can still reference ......
Read more >Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start FreeTop Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found
Top GitHub Comments
@CottageDwellingCat I was just about to post that 😅
This does not appear to be a realistic idea for now