question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Feature: `ParameterSummary` above the method

See original GitHub issue

Hello 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:closed
  • Created a year ago
  • Comments:12 (9 by maintainers)

github_iconTop GitHub Comments

1reaction
exsersewocommented, Mar 24, 2022

@CottageDwellingCat I was just about to post that 😅

0reactions
csmircommented, Feb 9, 2023

This does not appear to be a realistic idea for now

Read more comments on GitHub >

github_iconTop 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 >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found