我一直在阅读一些 issues在 github 上和 projects建立在 Flow 之上，用于在 Flow 和 JSDoc 之间创建“桥梁”，或者简单地从 Flow 类型注释生成 JSDoc。
他们都没有回答我这个“简单”的需求:
问:如何将 Flow 类型包含到 JSDoc 中？
我不想摆脱 JSDoc 注释 block ，因为它们不仅用于类型检查，还用于文档和向其他人或您 future 的自己解释代码。
我想要的是:
// @flow
// This file should be parsed by flow
// 1) Use all the advantages of flow
type MyObject = {
foo: number,
bar: boolean,
baz: string,
};
// later..
// 2) Comment AND annotate FLOW TYPE using JSDoc, not the Flow syntax
/**
* Make super complex thing
* @param {MyObject} val an object of type MyObject
* @returns {String} an interesting value
*/
function superComplexThingy(val) {
return val.baz
}
总而言之，我想:
- 利用流的所有优点(如上面的类型定义)
- 使用 JSDoc 而非 Flow 语法评论和注释 FLOW TYPE
这可能吗？怎么办？
最佳答案
超晚响应，但这不是 Flow 支持的东西，而且很可能不会得到支持。如果您想编写自己的转译器将一些 jsdoc 注释转换为 Flow 类型，您也许可以做到，但这需要大量工作。
其他一些人已经尝试过这类事情，但似乎不太活跃:https://github.com/Kegsay/flow-jsdoc
关于javascript - 将流类型包含到 JSDoc 中，我们在Stack Overflow上找到一个类似的问题： https://stackoverflow.com/questions/46158469/