如何让Lazarus IDE在悬停提示中显示实现区的类方法注释？

我希望规范编写代码文档，Lazarus IDE支持鼠标悬停标识符时显示工具提示：默认会选取标识符关联的第一条注释作为提示内容，类成员的注释需要写在接口区（因为标识符首次出现于此）。但存在差异：函数需在声明上方加注释才会显示提示，属性在声明后加注释即可正常显示。我觉得这种方式会让源码文件显得杂乱，更倾向于把函数行为注释写在实现区的函数上方，请问能否实现该需求？或是有更优的代码文档编写方式？

最小可复现代码 #

unit CalculatorUnit;

interface

type

  { TCalculator }

  TCalculator = class
  private
    Fnumber1: integer;
    procedure Setnumber1(AValue: integer);
  public
    function Add(a, b: Double): Double; /// 函数声明后的注释不会显示在提示中

    // 函数声明上方的注释会显示在提示中
    function Multiply(a, b: Double): Double;

    property number1: integer read Fnumber1 write Setnumber1; // 属性声明后的注释会显示在提示中
  end;

implementation

{ TCalculator }

procedure TCalculator.Setnumber1(AValue: integer);
begin
  if Fnumber1 = AValue then Exit;
  Fnumber1 := AValue;
end;

// 实现区方法上方的注释不会显示在提示中
function TCalculator.Add(a, b: Double): Double;
begin
  Result := a + b;
end;

function TCalculator.Multiply(a, b: Double): Double;
begin
  Result := a * b;
end;

// 这个注释会显示在提示中，因为该过程不属于类且未在接口区声明
procedure sayHello();
begin
  writeLn('Hello World');
end;

end. 

可行解决方案 #

1. 利用内置注释同步功能 #

Lazarus自带的CodeTools支持将实现区的注释同步到接口区的声明处，步骤如下：

• 在实现区的函数上方编写清晰的注释（推荐用结构化格式，见下文）
• 打开「Tools」→「Code Tools」→「Synchronize Comments」，IDE会自动将实现区的注释复制到对应接口区的函数声明上方
• 配置注释模板：在「Tools」→「Options」→「Editor」→「Code Templates」中，创建带参数的函数注释模板（比如包含@param、@return的结构化注释），编写注释时一键调用，提升效率

2. 使用结构化注释语法 #

采用Lazarus支持的结构化注释格式（兼容IDE提示和文档生成），示例如下：

implementation

{ TCalculator }

(**
  计算两个数值的和
  @param a 第一个加数
  @param b 第二个加数
  @return 返回两个数相加的结果
*)
function TCalculator.Add(a, b: Double): Double;
begin
  Result := a + b;
end;

同步到接口区后，IDE会识别该注释并在悬停时显示完整提示，同时这种格式还能用于生成标准的API文档（通过「Tools」→「Generate Documentation」功能）。

3. 第三方插件增强（进阶） #

可以安装DocInspector等第三方插件，这类插件支持直接读取实现区的注释作为IDE提示，无需手动同步注释。不过需要注意插件与当前Lazarus版本的兼容性。

最优实践推荐 #

优先选择「结构化注释+内置同步功能」的组合：

• 在实现区编写完整的函数行为注释（包含参数、返回值说明），保持代码逻辑与文档的关联性
• 通过同步功能自动同步到接口区，满足IDE提示要求
• 定期使用文档生成功能导出API文档，提升项目的可维护性

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