跳到主要内容

多行注释的标记

常见的注释标记及其含义:

  • @deprecated: 用于表示该方法、函数或字段已被弃用
  • @param: 用于描述函数或方法的参数,指定参数的名称和类型。
  • @returns 或 @return: 用于描述函数或方法的返回值,指定返回值的类型和含义。
  • @throws 或 @exception: 用于描述函数或方法可能抛出的异常,指定异常的类型和原因。
  • @see: 用于指定相关的参考文档、类、方法或资源。
  • @example: 用于提供示例代码,展示如何使用该方法或函数。
  • @private: 用于标记私有的方法、函数或字段,表示它们不应该被外部访问。
  • @public: 用于标记公共的方法、函数或字段,表示它们可以被外部访问。
  • @protected: 用于标记受保护的方法、函数或字段,表示它们只能在继承类中访问。
  • @inheritdoc: 用于继承父类或接口的文档注释,表示继承了父类或接口的文档内容。