调整注释

Author: PatternDirClean

PDWebpack/cofig/conf.js

@@ -1,46 +1,67 @@
 /** 框架配置
  *
+ * @author fybug
  * @version 0.0.1
  * @since PDWebpack 0.0.1
+ * @class Conf
  */
 global.Conf = {
-    /** 加载模块加载顺序 */
+    /** 加载模块加载顺序
+     *
+     * @type ('ModeLoad'|'PageLoad'|'AnonymousLoad')[]
+     */
     configload: ['ModeLoad', 'PageLoad'],
 
-    // // 全局输出配置
-    // Out: {
-    //     // 编译资源后的替换的 url 地址
-    //     urlOf: ''
-    // },
-    // // 模块输出配置
-    // jsOut: {
-    //     outName: '[hash:12][name][id].js'
-    // },
-    // // css 输出配置
-    // cssOut: {
-    //     urlOf: './',
-    //     outName: '[hash:12][name][id].css'
-    // },
-    // // 字体文件输出配置
-    // fontOut: {
-    //     urlOf: './',
-    //     outName: 'static/[name].[ext]'
-    // },
-    // // 图片输出配置
-    // imgOut: {
-    //     urlOf: './',
-    //     outName: 'static/[id][name][hash:9].[ext]'
-    // },
+    // 全局输出配置
+    Out: {
+        /** 编译资源后的替换的 url 地址
+         *
+         * @type string
+         */
+        urlOf: ''
+    },
+    // 模块输出配置
+    jsOut: {
+        /** 输出名称
+         *
+         * @type string
+         */
+        outName: '[hash:12][name][id].js'
+    },
+    // css 输出配置
+    cssOut: {
+        urlOf: './',
+        outName: '[hash:12][name][id].css'
+    },
+    // 字体文件输出配置
+    fontOut: {
+        urlOf: './',
+        outName: 'static/[name].[ext]'
+    },
+    // 图片输出配置
+    imgOut: {
+        urlOf: './',
+        outName: 'static/[id][name][hash:9].[ext]'
+    },
 
     /** 开发者模式下的专属配置 */
     devtool: {
         /** 测试状态模块输出名称 */
         jsOut: {outName: '[name].js'},
-        /** 测试服务器端口 */
+        /** 测试服务器端口
+         *
+         * @type number
+         */
         port: 3000,
-        /** 测试服务器访问地址 */
+        /** 测试服务器访问地址
+         *
+         * @type string
+         */
         host: "localhost",
-        /** 测试过程存放路径 */
+        /** 测试过程存放路径
+         *
+         * @type string
+         */
         contentBase: './build'
     }
 };

PDWebpack/cofig/pathConf.js

@@ -1,11 +1,13 @@
 /* 路径常量 */
 
 /** 项目根目录
+ *
  * @author fybug
  * @since PDWebpack 0.0.1
  */
 global.RootPath = path.resolve(__dirname, '../../') + '/';
 /** 全局输出路径
+ *
  * @author fybug
  * @since PDWebpack 0.0.1
  */

PDWebpack/cofig/plugins/HtmlWebpackPlugin.js

@@ -1,10 +1,11 @@
-/** HtmlWebpackPlugin 基础基础
- *
+/**
  * @author fybug
  * @version 0.0.1
  * @since PDWebpack 0.0.1
+ *
+ * @return {{meta:Object,cache:boolean,minify:Object}}
  */
-WebPackPlugins.HtmlWebpackPlugin = () => {
+module.exports = () => {
     return {
         meta: {
             "viewport": "width=device-width, initial-scale=1, shrink-to-fit=n",

PDWebpack/cofig/plugins/ScriptExtHtmlWebpackPlugin.js

@@ -1,9 +1,14 @@
-/** ScriptExtHtmlWebpackPlugin 基础配置对象
- *
+/**
  * @author fybug
  * @version 0.0.1
  * @since PDWebpack 0.0.1
+ *
+ * @return {{
+ *     sync:string[],
+ *     defer:string[],
+ *     async:string[]
+ * }}
  */
-WebPackPlugins.ScriptExtHtmlWebpackPlugin = () => {
+module.exports = () => {
     return {sync: [], defer: [], async: []}
 };

PDWebpack/cofig/plugins/pluginsload.js

@@ -6,8 +6,19 @@
  * @author fybug
  * @version 0.0.1
  * @since PDWebpack 0.0.1
+ * @class WebPackPlugins
  */
-global.WebPackPlugins = {};
-
-require('./ScriptExtHtmlWebpackPlugin');
-require('./HtmlWebpackPlugin');
+global.WebPackPlugins = {
+    /** HtmlWebpackPlugin 基础基础
+     *
+     * @class HtmlWebpackPlugin
+     * @constructs
+     */
+    HtmlWebpackPlugin: require('./HtmlWebpackPlugin'),
+    /** ScriptExtHtmlWebpackPlugin 基础配置对象
+     *
+     * @class ScriptExtHtmlWebpackPlugin
+     * @constructs
+     */
+    ScriptExtHtmlWebpackPlugin: require('./ScriptExtHtmlWebpackPlugin')
+};

PDWebpack/cofig/webpack/conf.js

@@ -6,6 +6,19 @@
  * @author fybug
  * @version 0.0.1
  * @since PDWebpack 0.0.1
+ *
+ * @return {{
+ *     output:{
+ *         filename:string,
+ *         path:string,
+ *         publicPath:string
+ *     },
+ *     externals:Object,
+ *     resolve:{extensions:string[]}
+ *     module:{rules:{}},
+ *     plugins:Object[],
+ *     performance:{hints:boolean}
+ * }}
  */
 global.WebpackConf = () => {
     // 实例化框架配置读取工具

PDWebpack/cofig/webpack/externals.js

@@ -1,4 +1,7 @@
-/** 脱离的第三方库 */
+/** 脱离的第三方库
+ *
+ * @return {Object}
+ */
 module.exports = (confget, conf) => {
     return {};
 };

PDWebpack/cofig/webpack/plugins.js

@@ -1,4 +1,7 @@
-/** 加载的插件 */
+/** 加载的插件
+ *
+ * @return {Object[]}
+ */
 module.exports = (confget, conf) => [
     // 清理输出
     new CleanWebpackPlugin({dry: false, protectWebpackAssets: true}),

PDWebpack/cofig/webpack/resolve.js

@@ -1,4 +1,7 @@
-/** 自动补充文件拓展 */
+/** 自动补充文件拓展
+ *
+ * @return {{extensions:string[]}}
+ */
 module.exports = (confget, conf) => {
     return {extensions: ['.js', '.jsx']};
 };

PDWebpack/cofig/webpack/rules.js

@@ -1,4 +1,7 @@
-/** 文件加载规则 */
+/** 文件加载规则
+ *
+ * @return {{}[]}
+ */
 module.exports = (confget, conf) => [
     // css 和 postcss 的加载处理
     {