JSDoc在SCP上的Grunt构建过程中未生成文件

2020-08-27 03:34发布

         点击此处--->   EasySAP.com群内免费提供SAP练习系统(在群公告中)

加入QQ群:457200227(SAP S4 HANA技术交流) 群内免费提供SAP练习系统(在群公告中)


嗨,

我们正在基于nodeJS和SAPUI5在SCP上开发应用程序。 要自动生成技术文档,我们要使用JSDoc,因为它已集成在webIDE中。 生成标签工作正常,我们也设法扩展了基于grunt的构建过程,因此调用了JSDoc。 我们遵循了本教程:

https://blogs.sap.com/2017/09/18/auto-documentation-using-grunt-in-the-multi-cloud-webide /作者: Jakob MariusKjær

日志显示以下内容:

 11:57:29(执行员)正在运行" jsdoc:dist"(jsdoc)任务
 11:57:29(执行员)>>生成到/projects/projectname/web/doc的文档
 11:57:29(执行员)
 11:57:29(执行员)完成。

但是" doc"目录仍然为空。 没有其他日志条目可见,也没有错误报告,因此我不确定如何解决此问题。 JSDOC应该在其中搜索* .js文件的目录是正确的。

有人知道如何找出问题所在吗?

谢谢

         点击此处--->   EasySAP.com群内免费提供SAP练习系统(在群公告中)

加入QQ群:457200227(SAP S4 HANA技术交流) 群内免费提供SAP练习系统(在群公告中)


嗨,

我们正在基于nodeJS和SAPUI5在SCP上开发应用程序。 要自动生成技术文档,我们要使用JSDoc,因为它已集成在webIDE中。 生成标签工作正常,我们也设法扩展了基于grunt的构建过程,因此调用了JSDoc。 我们遵循了本教程:

https://blogs.sap.com/2017/09/18/auto-documentation-using-grunt-in-the-multi-cloud-webide /作者: Jakob MariusKjær

日志显示以下内容:

 11:57:29(执行员)正在运行" jsdoc:dist"(jsdoc)任务
 11:57:29(执行员)>>生成到/projects/projectname/web/doc的文档
 11:57:29(执行员)
 11:57:29(执行员)完成。

但是" doc"目录仍然为空。 没有其他日志条目可见,也没有错误报告,因此我不确定如何解决此问题。 JSDOC应该在其中搜索* .js文件的目录是正确的。

有人知道如何找出问题所在吗?

谢谢

付费偷看设置
发送
1条回答
CJones
1楼-- · 2020-08-27 04:10

您好多米尼克

我还使用了上面的教程作为参考,对我来说,它奏效了。

就我而言,因为我已经有了项目构建配置,所以这就是我需要添加的内容(我在文件中放了一些代码片段)。

  • Gruntfile.js
 ...
 grunt.loadTasks(" tasks");

//实际上,只需要添加" jsdoc"
 grunt.registerTask(" default",[" clean"," lint"," build"," jsdoc"]);  
  • package.json
///只需要添加" grunt-jsdoc"
 ...
 " devDependencies":{
 " @ sap/grunt-sapui5-bestpractice-build":" 1.3.65",
 " grunt-jsdoc":" ^ 2.1.1"
 }
 
  • jsdoc.js
//您需要检查您拥有的确切项目结构
 module.exports =函数(咕unt声){
 grunt.config(" jsdoc",{
 dist:{
 src:[" ./webapp/*。js"," ./webapp/controller/*。js",
 " ./webapp/util/*.js"],
 选项:{
 目的地:" doc"
 }
 }
 });
 grunt.loadNpmTasks(" grunt-jsdoc");
 };
 

希望它可以帮助您确定问题所在。

一周热门 更多>