0.0.2 • Published 8 years ago
gulp-javadoc v0.0.2
关于本gulp插件
意图
- 如果你或你的公司对代码质量要求很高,包括对代码的编写规范,那么你可能会遇到这样的工作:修改成千上万个不规范的代码编写,如javadoc编写规范、变量名命名规范、代码长度限制等等。很难过,作者就遇到了这样的工作。 程序员的职责就在于遇到问题解决问题,于是我开始尝试能够让其自动化修改的方式。
作为一名前端爱好者,gulp、grunt等利器当然一个都不能少,本插件基于gulp开发,能够让你一键规范化。
如何使用
- 首先你得能够运行gulp 如何安装node环境和gulp插件 相信不用我多说了。
HTML、js版本
- 如果你需要少数几个文件,每个文件中有大量的缺陷,建议你使用HTML版本直接运行在浏览器上操作。
gulp插件版本
- 如果你有n多个文件需要修复,建议你使用gulp-javadoc 运行在node中实现,这样可以一劳永逸。
- 使用方法
/**
* Created by rowthan on 2016/9/30.
*/
// 引入 gulp
var gulp = require('gulp');
var javadoc = require("gulp-javadoc");
gulp.task("autofix",function(){
gulp.src('autofix/java/**/*.java') //待修复java文件地址
.pipe(javadoc()) // 运行方法
.pipe(gulp.dest('autofix/fixedjava')) // 修复后存储地址
});
// 默认任务
gulp.task('default', function(){
gulp.run('autofix');
});
参考gulp-javadoc/example
注意、建议
- 本插件经检测 可以修复大多数javadoc缺陷
- 经测试,可能存在修复缺陷的情况有 注释中使用"{"或"}"
- 建议结合git使用,修复完后检查一下(如有必要,在下一版本中会加入报告功能)