我测试了Doxygen和多个GitHub项目(jsdoc,react-docgen,react-doc-generator使用npm i -g如下:
react-doc-generator ./ -o DOCUMENTATION.md
react-docgen --pretty -o out/reactdocgen.html ./
jsdoc ./src
doxywizard
Run Code Online (Sandbox Code Playgroud)
但没有人真正理解最近的ES6 JavaScript和JSX for React Native(甚至没有提到本机代码).我最终得到了无用的文档.
当然,我试图添加注释(和don的\ fn),但是注释完全由手工输入(未生成),有时文档中的代码不存在.
/**
*
*
* @class MainScreen
* @extends {Component}
*/
class MainScreen extends Component {
/**
*
* \fn navigationOptions()
* @static
* @memberof MainScreen
*/
Run Code Online (Sandbox Code Playgroud)
最后我没有找到jsdoc文件夹和子文件夹的方法(但是评论文件的测试结果是subpar).
所以我转向React Native文档大师问:如何为React Native生成文档?
如果仅来自评论,您是否有工具从RN + ES6(+ Native)代码生成注释?
javascript diagram native documentation-generation react-native