如何在discord.py中为命令配置自定义子帮助信息

你可以通过两种常用方式为hi命令自定义!help触发时的说明内容：

方法1：在command装饰器中传入帮助相关参数 #

discord.py的commands.command()装饰器原生支持多个用于帮助展示的参数，直接传入对应内容即可：

• brief：命令的简短说明，在展示命令列表时显示
• help：命令的详细说明，输入!help 命令名时展示的主体内容
• usage：命令的用法示例，需要传参时可以标注参数格式

修改后的代码示例如下：

class xkcd(commands.Cog):
  def __init__(self, bot):
    self.bot = bot

  @commands.command(
    brief="向机器人打招呼",
    help="该命令无需传入任何参数，调用后机器人会回复问候语",
    usage="!hi"
  )
  async def hi(self, ctx):
    await ctx.send('hey')

方法2：使用函数 docstring 作为帮助内容 #

如果你不想把说明写在装饰器里，也可以直接把帮助内容写在函数的文档字符串中，discord.py会自动读取该内容作为!help hi的展示内容：

class xkcd(commands.Cog):
  def __init__(self, bot):
    self.bot = bot

  @commands.command()
  async def hi(self, ctx):
    """
    向机器人打招呼
    该命令无需传入任何参数，调用后机器人会回复问候语
    用法示例：!hi
    """
    await ctx.send('hey')

完成上述任意一种修改后，再输入!help hi就会展示你填写的自定义说明内容。

内容的提问来源于stack exchange，提问作者MockingJay