我所处的旧项目太大,无法很容易地转换为类型记录,所以我一直在使用JSDoc。我无法理解如何在JSDoc中复制的类型记录功能是使用as const来完整地键入静态对象的属性名和值。// In Typescript// (type shows as {hello:'world'} insteadof {he
我在github上阅读了一些,并在流的基础上构建了,用于在流和JSDoc之间创建“桥梁”,或者简单地通过流类型注释生成JSDoc。他们都没有回答我这个“简单”的需要:我不想删除JSDoc注释块,因为它们不仅用于类型检查,而且用于文档和向其他人或您未来的自我解释代码。.
// 2) Comment AND annotate FLOW TYPE using <
我使用PHPDoc和JSDoc作为我的源代码。我知道有一些工具可以用这些文档构建API。然而,我想知道的是,如何解释复杂的代码呢?我是否只是在函数内部使用多行注释,而不是在PHPDoc/JSDoc中解释呢?/**
* Lorem ipsum dolor sit amet.我认为我不能在JSDoc中这样做,因为它用于构建API (这是关于
但是,当我在其他文件中导入这个类并使用它创建一个新对象(const logger = new Logger())时,自动建议只显示类中的函数,即// some other function。现在,因为我的类返回一个Winston记录器实例,所以我希望能够用JS文档记录它,这样我就可以得到我的自动建议。有没有一种方法可以使用JS doc来实现这一点,以定义已经定义的类返回的自定义对象类型?