# MrdocTools

**Repository Path**: yanggenjie/mrdoc-tools

## Basic Information

- **Project Name**: MrdocTools
- **Description**: 觅思文档的二次开发工具
- **Primary Language**: C#
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2023-08-18
- **Last Updated**: 2023-08-28

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# MrdocTools

本项目采用`.NET 6`,支持到 C# 10。`.NET 6` 以上目前仅支持 visual Studio 2022，Visual Studio 2019 支持的最高版本为`.NET 5` ，详见：[.NET SDK](https://dotnet.microsoft.com/zh-cn/download/visual-studio-sdks?cid=getdotnetsdk)

关于`.Net` 和 C#版本的关系: [C#版本历史记录](https://learn.microsoft.com/zh-cn/dotnet/csharp/whats-new/csharp-version-history#c-version-80)

`.NET Framework` 框架只能在 windows 上运行，但各种跨平台的需求原来越强烈，不能满足跨平台、模块化的需求。

微软把`.NET Framework `可以跨平台的部分提取出来，封装成标准库就是`.NET Standard`。无论哪个系统平台上，标准库里内容是完全通用的。

但其他系统的特有的部分在 Windows 中也没有，所以在标准库`.NET Standard`基上开发出来`.NET Core`。`.NET Core`稳定后，改名成`.NET 5/6/7`。

## 变量命名风格

常见的几种命名：

- 小驼峰(lowerCamelCase)：除第一个单词之外，其他单词首字母大写；如 lowerCamelCase
- 大驼峰(UpperCamelCase)：每个单词的第一个字母都要大写；如 UpperCamelCase
- 蛇形命名法(snake_case)：又称下划线命名，每个单词都小写，各个单词之间通过下划线，或者每个单词都大写，各个单词之间通过下划线；如 snake_case，SNAKE_CASE
- 匈牙利命名法(Hungarian)：其基本原则是，变量名=属性+类型+对象描述。其中每一对象的名称都要求有明确含义，可以取对象名字全称或名字的一部分。如成员变量 m_hungarian，全局变量 g_hungarian 等，基本**不推荐使用**此命名风格。

### 本项目的一些原则

对于需要序列化接受 Web 接口的类，其命名风格以提供的 API 命名风格为准，不守以下准则约束。

- 局部变量、方法的参数名、私有成员、受保护成员，**使用小驼峰**命名。
  > 由于局部变量、私有的成员变量都使用小驼峰，可以使用 this 来区分私有的成员变量和局部变量
- 除了局部变量、方法参数、私有成员、受保护成员，其余命名风格均**使用大驼峰**命名
- 对于 bool 型属性或者变量使用 Is（is）作为前缀，不要使用 Flag 后缀，例如应该使用 IsDeleted,而不要使用 DeleteFlag
- C#中**不要以下划线开头**命名变量来表示私有成员，如不能命名成： `_Value`，因为 C#使用`_`来表示[弃元](https://learn.microsoft.com/zh-cn/dotnet/csharp/fundamentals/functional/discards)，容易产生误解。
- 在**简单的**循环语句中计数器变量使用 i, j, k, l, m, n，如有多个循环嵌套，如表示行和列，可以使用有意义的命名，如 row,column 等。
- 类的成员分布顺序：在类的**顶部声明**所有的成员变量，静态变量声明在最前面，然后是非静态的成员变量，最后是方法、枚举等；