Bitwarden 贡献文档
⮐ Bitwarden Contributing Documentation我的博客联系我
  • 关于
  • 入门
    • 概述
    • 工具
    • 服务器
      • 设置指南
      • 高级服务器设置
      • 数据库
        • MSSQL
        • 实体框架
      • 事件日志
      • Ingress 隧道
      • SCIM
      • 自托管指南
      • 系统管理门户
      • 单点登录 (SSO)
        • 本地 IdP
        • Okta
      • 故障排除
      • 用户机密
      • 公共 API
    • 网页客户端
      • 网页密码库
        • WebAuthn
      • 浏览器端
        • 生物识别解锁
        • Firefox 隐私模式
      • 桌面端
        • Mac App Store Dev
        • Microsoft Store
        • Native Messaging Test Runner
        • 更新测试
      • CLI
      • 故障排除
    • 移动端
      • Android
        • F-Droid
      • iOS
      • .NET MAUI (legacy)
        • Android
        • iOS
        • watchOS
    • SDK
      • 内部 SDK
      • Secrets Manager
        • Integrations
          • Kubernetes
    • 业务 App
      • 目录连接器
        • JumpCloud
        • OpenLDAP Docker 服务器
      • Key Connector
      • Splunk App
  • 贡献
    • 贡献
    • 代码样式
      • =Android & Kotlin
      • Angular & TypeScript
      • C#
      • =Rust
      • T-SQL
      • =Swift
      • Tailwind
    • 数据库迁移
      • 进化数据库设计
    • 提交签名
    • 拉取请求
      • =贡献审查程序
      • 分支
      • 代码审查
      • UI 审查 - Chromatic
    • 无障碍
    • 依赖管理
    • 功能标记
    • 模板存储库
    • 测试
      • =数据库集成测试
      • 负载测试
      • 单元测试
        • 命名约定
        • 测试结构
    • 修改用户机密
  • 架构
    • 架构
    • 架构决策记录 (ADR)
      • 0001 - Angular Reactive Forms
      • 0002 - Public API for modules
      • 0003 - Adopt Observable Data Services for Angular
      • 0004 - Refactor State Service
      • 0005 - Refactor Api Service
      • 0006 - Clients: Use Jest Mocks
      • 0007 - Manifest V3 sync Observables
      • 0008 - Server: Adopt CQRS
      • 0009 - Composition over inheritance
      • 0010 - Angular Modules
      • 0011 - Scalable Angular Clients folder structure
      • 0012 - Angular Filename convention
      • 0013 - Avoid layered folder structure for request/response models
      • 0014 - Adopt Typescript Strict flag
      • 0015 - Short Lived Browser Services
      • 0016 - Move Decryption and Encryption to Views
      • 0017 - Use Swift to build watchOS app
      • 0018 - Feature management
      • 0019 - Adoption of Web Push
      • 0020 - Observability with OpenTelemetry
      • 0021 - Logging to Standard Output
      • =0022 - Authorization
      • =0023 - Identifying Integrated Clients
    • 移动客户端架构
      • =Android
      • =iOS
        • =推送通知故障排除提示
      • =.NET MAUI (legacy)
        • =概述
        • watchOS
    • =SDK 架构
      • =数据模型
      • =依赖
      • Password Manager
        • Web
          • =互操作性
      • =Secrets Manager
      • =服务器绑定
      • =版本控制和破坏性更改
    • 网络客户端架构
      • 概述
      • 数据模型
      • 表示层
        • Angular
        • CLI
      • =依赖注入
      • 服务层
        • Vision
        • 实现
    • 服务器架构
    • 深度剖析
      • 身份验证
        • 双重身份验证
      • =授权
      • =浏览器自动填充
        • 收集页面详细信息
        • 生成并执行填充脚本
        • 表单提交检测
        • Shadow DOM
        • =内联自动填充菜单
      • Captcha
      • =只读数据库副本
      • 事件日志
      • =FIDO2 和通行密钥
        • =凭据
        • =操作
        • =命名惯例
        • =实现
          • =提供程序
            • =浏览器扩展
          • =依赖方
            • =用于解密的通行密钥
        • =术语表
      • 推送通知
        • 移动端推送通知
        • 其他客户端推送通知
      • =SSH 密钥和代理
        • =SSH 代理
      • =状态提供程序框架
        • =派生状态
    • =安全
      • =定义
      • =原则
        • =P01 - 锁定的密码库是安全的
        • =P02 - 半受损设备密码库的有限安全性
        • =P03 - 完全损坏的系统没有安全性
        • =P04 - 控制密码库数据的访问权限
        • =P05 - 将安全漏洞的影响降至最低
      • =要求
由 GitBook 提供支持
在本页
  • 私有字段
  • 公共属性
  • 空白区
  • 构造函数
  • 控制块
  • 条件句
  1. 贡献
  2. 代码样式

C#

上一页Angular & TypeScript下一页=Rust

最后更新于1年前

对应的

我们使用 工具来格式化我们的 C# 代码。像如下运行:

dotnet format

然而,由于它相当初级,我们还遵循一些额外的代码样式指南。

我们尝试遵循 C# 社区标准(有一些例外)。查看以下文章获取总体概述。

私有字段

私有字段应使用 camelCase 格式并以 _ 作为前缀。

示例:

private readonly IUserService _userService;

请参阅以下文章,了解如何配置 Visual Studio 代码生成快捷方式以协助此命名约定:

公共属性

  • 属性应使用 PascalCase 格式并且没有前缀

  • 属性应拼写出来,而不要使用缩写或简称,例如「OrganizationConfiguration」(正确)与「OrgConfig」(错误)

  • 属性应在属性组和以下方法之间包含空行

空白区

  • 我们对所有代码文件使用空格(不是制表符),包括 C#。缩进应该是标准的 4 个空格。

  • 代码文件应在最后的 } 后以换行符结尾

  • 空行用于分隔每组代码组合类型(字段、构造函数、属性、公共方法、私有方法、子类)

构造函数

  • 多个构造函数应使用换行符分隔(之间有空行)

  • 具有多个参数的构造函数应每行列出 1 个参数

  • 必要时,空的构造函数应全位于为 1 行,即 public ClassName() { }

控制块

  • 控制块应始终使用大括号(即使是 1 行大括号)

  • using 和 foreach 块应该用 var 声明上下文变量

  • 在控制关键字和 () 之间始终包含一个空格

条件句

当跨多行分隔时,长条件应使用尾随运算符。

// Good example
if (someBooleanExpression &&
    someVariable != null &&
    someVariable.IsTrue)
{
}

// Bad examples (don't do)
if (someBooleanExpression
    && someVariable != null
    && someVariable.IsTrue)
{
}
// Too long, separate
if (someBooleanExpression && someVariable != null && someVariable.IsTrue)
{
}

[译者注]:PascalCase - 大驼峰命名法。是电脑编程时的一套命名规则。当变量名或函数名是由两个或多个单词连结在一起,利用驼峰式命名法来表示,以增加变量和函数的可读性。单词之间不以空格、连接号或下划线等隔开。第一个单词的首字母小写,第二个单词的首字母大写(小驼峰),或者每一个单词的首字母均大写(大驼峰。也被称为 Pascal 命名法)。

官方页面地址
dotnet-format
https://docs.microsoft.com/zh-cn/dotnet/csharp/programming-guide/inside-a-program/coding-conventions
https://stackoverflow.com/a/310967/1090359
https://stackoverflow.com/q/45736659/1090359
骆峰式命名法