Для чего [Summary ("")] используется в discord.net?

Question

Я хочу сделать команду помощи в discord.net, и мне интересно, что делает [Summary("")].Можно ли получить сводку команды?Сводка в discord.net похожа на description: в discord.js-commando?Я выполнил поиск в Google и не смог найти никаких результатов о том, что он делает.

Как получить сводку, если я хочу сделать команду помощи и что она делает?

Answer 1

Атрибут Summary используется для предоставления некоторой информации о классах, методах или параметрах метода.По сути, это действует как форма «метаданных» для документирования вашего кода и позволяет создавать, например, команду «help», которая автоматически собирает все атрибуты Summary из групп команд, самих команд и входных данных.параметры для командного метода.Это автоматически обновит команду «help», поэтому вам не придется делать это вручную.

Некоторый базовый код для демонстрации использования:

[Command("Help")]
public async Task Help()
{
    List<CommandInfo> commands = _commandService.Commands.ToList();
    EmbedBuilder embedBuilder = new EmbedBuilder();

    foreach (CommandInfo command in commands)
    {
        // Get the command Summary attribute information
        string embedFieldText = command.Summary ?? "No description available\n";

        embedBuilder.AddField(command.Name, embedFieldText);
    }

    await ReplyAsync("Here's a list of commands and their description: ", false, embedBuilder.Build());
}