DarkM

# 更新日志 2022-08-07

# 文档更新

1、完善 01_Utils.md 通用库文档（936 行）⭐

  • 基于源代码完整梳理 Utils.Core 和 Utils.Mvc
  • 新增 11 个功能分类的详细 API 说明
  • 补充数据转换/字符串/Guid/Enum 等扩展方法
  • 新增 ResultModel、Helper 工具类、加密类文档
  • 添加最佳实践指南

2、修复 02_Data.md 数据访问文档编译错误 🐛

  • 问题：VuePress 将泛型符号 <TEntity> 误认为 HTML 标签
  • 错误：tag <TEntity> has no matching end tag
  • 修复：将标题和表格中的泛型符号用反引号包裹
  • 涉及：IDbSet<TEntity>, List<TEntity>, IEnumerable<TEntity> 等

3、在 VuePress 导航中添加三个基础文档入口

  • 系统架构总览（Architecture.md）
  • 模块目录（ModuleCatalog.md）
  • 系统清单（SystemCatalog.md）

# Git 提交

4、DarkM.Docs 项目提交

  • d0bfa6d - 修复 02_Data.md 编译错误 - 泛型符号导致 VuePress 解析失败 ✅ 已推送
  • f804e83 - 更新 2022-08-07 更新日志 - 补充 Utils 文档完善记录 ✅ 已推送
  • ad71e6f - 完善通用库 (Utils) 文档 - 基于源代码补充完整 API 说明 ✅ 已推送
  • 981a8df - 新增架构文档入口与更新日志 (2022-03-01/03-02) ✅ 已推送
  • 5e47f2d - 更新模块目录文档至 v1.1 - 新增数据访问层 API 文档说明 ✅ 已推送

8、全面优化指南 (Guide) 文档 ⭐

  • README.md: 更新介绍、架构分层、快速链接
  • Modular.md: 七大特点、观察者模式示例、架构图
  • GetingStart.md: 前置要求、配置详解、部署流程、FAQ
  • CreateModule.md: 5 步骤流程、代码示例、最佳实践
  • InstallModule.md: 安装列表、高级配置、权限流程
  • 统一风格：表格、emoji、代码块、提示框

9、完善规范 (Guidelines) 文档 ⭐

  • CodeGuidelines.md: C#/Vue编码规范、审查清单、对比示例
  • DevGuidelines.md: Git工作流、提交规范、Code Review、测试/版本/部署规范
  • 新增 Mermaid 流程图、表格、代码示例

10、全面优化 DevGuidelines.md ⭐⭐

  • 完整开发流程图（10 阶段）
  • Git Flow 详解（6 种分支完整操作流程）
  • Commit Message 规范（12 种 Type/10 种 Scope/完整示例）
  • Code Review 详解（MR 模板/审查清单/意见规范）
  • 测试规范（单元测试/集成测试/E2E 示例）
  • 版本管理（SemVer/发布流程/CHANGELOG）
  • 部署规范（4 环境/检查清单/部署脚本）
  • 项目管理（用户故事/故事点/任务看板）
  • 安全规范（OWASP Top 10 防护示例）

11、全面优化平台搭建文档 ⭐⭐

  • Git.md: GitLab 服务器搭建（Docker/Ubuntu/配置/用户管理/CI/CD）
  • NuGet.md: BaGet 私有服务器（对比/安装/配置/打包/发布/监控）
  • Npm.md: Verdaccio 私有服务器（安装/配置/用户管理/发布/代理）
  • 每篇文档 15-20KB，包含完整示例和常见问题

12、全面优化 MSBuild 使用指南 ⭐

  • MSBuild 简介和优势说明
  • 项目文件结构（.csproj/props/targets 示例）
  • 常用命令速查（编译/发布/测试/打包）
  • NuGet 打包完整配置（多框架/元数据/Source Link）
  • 自定义 Target 示例（构建前后任务/模块描述生成）
  • 条件编译和属性配置
  • 高级用法（Task/批量处理/依赖管理）
  • CI/CD 集成（GitHub Actions/GitLab CI 示例）
  • 最佳实践（5 条实用建议）
  • 常见问题排查（构建失败/包冲突/打包错误）

12、全面优化 MSBuild 文档 ⭐

  • 从简单链接升级为完整指南（132 字节 → 25KB）
  • MSBuild 介绍和优势说明
  • 项目文件结构详解（.csproj/Directory.Build.props/targets）
  • 常用属性详解（项目/编译/NuGet/条件）
  • Item 元素详解（Package/Project/Content）
  • Target 目标详解（内置/自定义/条件执行）
  • Task 任务详解（常用 Task/自定义 Task）
  • 命令行使用（dotnet/msbuild 命令和参数）
  • DarkM 实战配置（完整.csproj 示例）
  • 调试和分析技巧（日志/性能优化/问题排查）
  • 最佳实践建议

13、全面优化 Admin 权限管理模块文档 ⭐

  • 模块概述表格（名称/类型/依赖/重要性）
  • 核心功能清单（8 大功能：账户/角色/菜单/权限/按钮/审计/配置/数据权限）
  • 安装配置详解（NuGet/NPM/配置文件）
  • 数据库表结构（核心表 + 关联表）
  • 权限系统设计（权限定义/编码规则/3 种访问级别）
  • 权限配置示例（完整 Controller 代码 + 权限解析结果）
  • 前端权限配置（3 种 page.js 配置示例）
  • Page/Button 属性完整说明表格
  • 审计日志系统（配置/审计内容/禁用方法）
  • 核心服务接口（IAccountService/IRoleService/IMenuService）
  • 常见问题排查（权限验证/菜单显示/按钮显示/审计日志）

14、全面优化前端核心框架文档 ⭐

  • 框架概述表格（名称/版本/基于/组件数/Git 仓库）
  • 核心特性说明（8 大特性：组件/Element-UI/多语言/皮肤/权限/扩展性/表单/工程化）
  • 完整技术栈（核心依赖/工具库/开发工具）
  • 项目结构详解（packages/src 目录树）
  • 快速开始（安装/引入/使用示例）
  • 组件体系（6 类组件：基础/布局/表单/列表/反馈/业务）
  • 国际化配置（支持 4 种语言/配置方法/切换语言）
  • 皮肤系统（内置 2 种皮肤/切换方法）
  • 权限系统（权限指令/权限判断）
  • HTTP 请求（封装方法/JWT 认证/RESTful API）
  • 工具函数（Assist 辅助/Regex 正则/Day.js 日期）
  • Vuex 状态管理（Store 结构/使用示例）
  • 开发环境（Node 版本管理/nvm 使用/开发命令）

15、全面优化前端子菜单文档（5 个）⭐

  • DevEnvironment.md: 环境要求/nvm 使用/依赖安装/开发命令/项目配置/常见问题
  • CssHelper.md: 命名规范/文本颜色/字体样式/内边距外边距/尺寸显示定位/边框阴影/Flex 布局
  • Skins.md: 核心概念/内置皮肤/使用方法/切换方法/自定义皮肤步骤
  • Login.md: 实现方式/完整代码示例/命名规范/内置组件/高级用法（SSO/扫码）
  • Q&A.md: 开发环境/依赖/样式/权限/接口问题/调试技巧（15 个典型问题）

← 2022-03-01 →