自我记录打字稿/ javascript代码

Question

您使用什么方法/工具来记录打字稿/ javascript代码？ 对于Visual Studio中的c＃，它非常简单。你只需输入＆＃34; ///＆＃34; IDE会自动为您创建文档存根。但打字稿怎么样？任何标准，工具和方法？

P.S。我更喜欢自我记录的方式不依赖于IDE。

Answer 1

  

任何标准，工具和方法

TypeScript文档遵循JavaScript文档实践，即JSDoc：http://usejsdoc.org/

  

我更喜欢自我记录的方式不依赖于IDE。

您可以自由输入以下内容

/** 
  * Some jsdoc comment 
  */
function someFunction() {
}

但是，当然IDE可以帮助您撰写此类评论。例如。 atom有docblockr：https://atom.io/packages/docblockr

当我完成当前的摩纳哥冲刺时，我打算将其功能整合到alm.tools