如何在 TypeScript 中动态生成文档字符串？

Question

有没有办法从 TypeScript 中的对象值动态生成注释/文档字符串？

我有一个看起来像这样的translations.json 文件：

{
  "hello": { "en": "hello", "de": "hallo" },
  "bye": { "en": "bye", "de": "tschüss" }
}

还有一个看起来像这样的translate.ts：

import type translations from './translations.json';

type TranslationKey = keyof typeof translations;

function translate(key: TranslationKey){
  // some translation code
}

当我使用translate() 函数时，我得到了 JSON-Object 的所有键作为完成建议。

现在我的问题是： 是否可以从 json 属性的值动态生成某种文档字符串？ 这样我的编辑器的建议弹出窗口就会将这些值显示为附加信息。

编辑器中的期望结果：

translate('<cursor>
          ╭───────╮╭───────────────╮
          │bye   >├┤bye            │
          │hello  ││───────────────│
          ╰───────╯│TranslationKey │
                   │en: bye        │
                   │de: tschüss    │
                   ╰───────────────╯

Answer 1

这些 JSON 完成条目由 vscode JSON 完成提供程序生成，无法配置为以特定方式构造这些项目。修改完成输出的唯一方法是编写自己的完成提供程序（对于如此简单的结果来说，这可能工作量太大）。