Question

我习惯于以特定的方式记录C＃项目中的代码，以提高团队效率，从Visual Studio中的Intellisense等中受益。

代码与此类似：

/// <summary>
/// Loads a user with a specific id.
/// </summary>
/// <param name="id">The id of the user to search for.</param>
/// <returns>A user with the given id.</returns>
public User GetUserById(string id) {
    ...
}

是否有类似的用于评论和文档的Typescript约定？甚至是使用这些约定从代码注释（如JavaDoc）生成html文档页面的工具？

Answer 1

是的。

最常用的评论约定（毫不奇怪）来自jsdoc形式的javascript。例如，VSCode支持它们out of the box。还有一些专门为typecript doc生成开发的工具，如typedoc

Answer 2

TSDoc是最近提出的用于注释和记录Typescript源文件的约定。其表示法如下-

/**
 * Returns the average of two numbers.
 *
 * @remarks
 * This method is part of the {@link core-library#Statistics | Statistics subsystem}.
 *
 * @param x - The first input number
 * @param y - The second input number
 * @returns The arithmetic mean of `x` and `y`
 */
function getAverage(x: number, y: number): number {
  return (x + y) / 2.0;
}

TypeDoc工具可以解析此约定中的注释并以HTML生成文档页面。

打字稿：是否有任何约定来记录带注释的代码？

2 个答案: