我读过一些issues在 github 上和projects构建在 Flow 之上，用于在 Flow 和 JSDoc 之间创建“桥梁”，或者简单地从 Flow 类型注释生成 JSDoc。
他们都没有回答我的这个“简单”需求：
问：如何将 Flow 类型包含到 JSDoc 中？
我不想摆脱 JSDoc 注释块，因为它们不仅用于类型检查，还用于文档并向其他人或未来的自己解释代码。
我想要的是这样的：
// @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
本文内容由网友自发贡献，版权归原作者所有，本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容，请联系:hwhale#tublm.com(使用前将#替换为@)
