docs: 优化文档和注释中的单词大小写和语义

This commit is contained in:
pany
2022-07-01 16:25:51 +08:00
parent 8378cb501f
commit f4dc67c4ec
30 changed files with 74 additions and 76 deletions

View File

@@ -7,7 +7,7 @@ import Unocss from "unocss/vite"
/** 配置项文档https://vitejs.dev/config */
export default (): UserConfigExport => {
return {
/** build 打包时根据实际情况修改 base */
/** 打包时根据实际情况修改 base */
base: "./",
resolve: {
alias: {
@@ -16,9 +16,9 @@ export default (): UserConfigExport => {
}
},
server: {
/** 是否开启 https */
/** 是否开启 HTTPS */
https: false,
/** host 设置为 true 才可以使用 network 的形式,以 ip 访问项目 */
/** 设置 host: true 才可以使用 Network 的形式,以 IP 访问项目 */
host: true, // host: "0.0.0.0"
/** 端口号 */
port: 3333,
@@ -43,9 +43,9 @@ export default (): UserConfigExport => {
brotliSize: false,
/** 消除打包大小超过 500kb 警告 */
chunkSizeWarningLimit: 2000,
/** vite 2.6.x 以上需要配置 minify: terserterserOptions 才能生效 */
/** Vite 2.6.x 以上需要配置 minify: "terser", terserOptions 才能生效 */
minify: "terser",
/** 在 build 代码时移除 console.log、debugger 和 注释 */
/** 在打包代码时移除 console.log、debugger 和 注释 */
terserOptions: {
compress: {
drop_console: false,
@@ -60,22 +60,22 @@ export default (): UserConfigExport => {
/** 打包后静态资源目录 */
assetsDir: "static"
},
/** vite 插件 */
/** Vite 插件 */
plugins: [
vue(),
/** svg */
/** SVG */
createSvgIconsPlugin({
iconDirs: [path.resolve(process.cwd(), "src/icons/svg")],
symbolId: "icon-[dir]-[name]"
}),
/** unocss */
/** Unocss */
Unocss()
/** 自动按需引入已更改为完整引入,所以注释了 */
/** 自动按需引入 (已更改为完整引入,所以注释了) */
// AutoImport({
// dts: "./types/auto-imports.d.ts",
// /** 自动按需导入 element-plus 相关函数,比如 ElMessage */
// /** 自动按需导入 Element-Plus 相关函数,比如 ElMessage */
// resolvers: [ElementPlusResolver()],
// /** 根据自动按需导入的相关 api,生成 .eslintrc-auto-import.json 文件供 eslint 识别 */
// /** 根据自动按需导入的相关 API,生成 .eslintrc-auto-import.json 文件供 Eslint 识别 */
// eslintrc: {
// enabled: true, // 默认 false
// filepath: "./types/.eslintrc-auto-import.json", // 默认 "./.eslintrc-auto-import.json"
@@ -84,7 +84,7 @@ export default (): UserConfigExport => {
// }),
// Components({
// dts: "./types/components.d.ts",
// /** 自动按需导入 element-plus 组件 */
// /** 自动按需导入 Element-Plus 组件 */
// resolvers: [ElementPlusResolver()]
// })
]