没有合适的资源?快使用搜索试试~ 我知道了~
首页Microsoft-C#编码规范
Microsoft-C#编码规范
5星 · 超过95%的资源 需积分: 14 29 下载量 86 浏览量
更新于2023-03-16
评论 1
收藏 269KB DOC 举报
本文档为一站式示例代码库项目组所使用的C++ 以及 .NET 编码规范 。该规范源自于产品开发过程中的经验,并在不断完善
资源详情
资源评论
资源推荐
Microsoft C#编码规范
本文档描述了微软一站式代码示例库项目组所采纳的关于本
地 和 (和 )代码的编程风格指导规范。
鸣谢
本文档的每一章节都应该感谢 Dan Ruder 微软 。 对本文档进行了斟字
酌句的查阅,并根据其 余年的编程经验提供了大量的珍贵评论 。我很荣幸能与他共事。
我同样感谢微软的四位经理,感谢他们对该项目的一贯支持。他们是 Vivian Luo,Allen Ding,Felix Wu和
Mei Liang。
同时,如果没有如下一站式代码示例库项目的关键成员的辛勤付出,本文档必定不会具有现在的技术深
度以及完整度,我在这里要感谢他们:
! "# $# %& '('
)# *'' +,# ! "#
本文档部分章节参考自一些微软产品组的编程规范。感谢他们的慷慨共享。
本编程规范在不断改善。如果您发现某些最佳实践或者话题并没有涵盖在本文档中,请告知我们一站式
示例代码库项目组 ,以不断充实改善本文档。我期待着您的参与。
声明
本编程规范文档以“如是”提供,无论明示或暗示都不包含任何形式保证,但并不限制适用于特殊目的的默
认担保。
当您编写 --代码时,敬请参考或使用本文档。但是,我们希望您能通过
(./0/ 告知我们您正在使用本文档,或给出任何改进建议。
目录
概览....................................................................................................................................................1
11原则和主旨1
1术语
通用编程规范.....................................................................................................................................3
12明确性和一致性2
13格式和风格2
14库的使用 4
15全局变量 4
16变量的声明和初始化4
17函数的声明和调用5
18代码语句 6
11枚举6
111大括号1
11注释1
112代码块
.NET 编码规范..................................................................................................................................20
113类库开发设计规范
114文件和结构
115程序集属性
116命名规范1
117常量4
118字符串5
1数组和集合6
11结构体2
1类 2
12命名空间24
13错误和异常24
14资源清理26
1
概览
本文档为一站式示例代码库项目组所使用的 以及 编码规范 。该规范源自于产品开发过程中的经
验,并在不断完善。如果您发现一些最佳实践或者话题并没有涵盖在本文档中,请联系我们一站式示例
代码库项目组 ,以不断充实完善本文档。
任何指导准则都可能会众口难调。本规范的目的在于帮助社区开发者提高开发效率,减少代码中可能出
现的 9,并增强代码的可维护性。万事开头难,采纳一个不熟悉的规范可能在初期会有一些棘手和困扰,
但是这些不适应很快便会消失,它所带来的好处和优势很快便会显现,特别是在当您接手他人代码时。
1.1 原则和主旨
高质量的代码示例往往具有如下特质:
1 易懂 – 代码示例必须易读且简单明确。它们必须能展示出重点所在。示例代码的相关部分应当易
于重用。示例代码不可包含多余代码。它们必须带有相应文档说明。
正确性 – 示例代码必须正确展示出其欲告知使用者的重点。代码必须经过测试,且可以按照文档
描述进行编译和运行。
2 一致性 – 示例代码应该按照一致的编程风格和设计来保证代码易读。 同样的,不同代码示例之间
也应当保持一致的风格和设计,使使用者能够很轻松的结合使用它们。一致性将我们一站式示例
代码库优良的品质形象传递给使用者,展示出我们对于细节的追求。
3 流行性 – 代码示例应当展示现行的编程实践,例如使用 ;(,错误处理,防御式编程以及可
移植性。示例代码应当使用当前推荐的运行时库和 )< 函数,以及推荐的项目和生成设置。
=15$0)#+,(
4 可靠性 – 代码示例必须符合法律,隐私和政策标准和规范。不允许展示入侵性或低质的编程实践,
不允许永久改变机器状态。所有的安装和执行过程必须可以被撤销。
5 安全性 示例代码应该展示如何使用安全的编程实践 :例如最低权限原则,使用运行时库函数的
安全版本,以及 ' 推荐的项目设置。
合理使用编程实践,设计和语言特性决定了示例代码是否可以很好满足上述特性。本编程规范致力于帮
助您创建代码示例以使使用者能够作为最佳实践来效仿和学习。
1.2 术语
在整个文档中,会有一些对于标准和实践的推荐和建议。一些实践是非常重要的,必须严格执行,另一
些指导准则并不一定处处适用,但是会在特定的场景下带来益处。为了清楚陈述规范和实践的意图,我
们会使用如下术语。
术语 意图 理由
一定请... 该规范或实践在任何情况下都应该遵守。如果您
认为您的应用是例外,则可能不适用。
该规范用于减少 9。
一定不要... 不允许应用该规范或实践。
您应该... 该规范和实践适用于大多数情况。 该规范用于统一编程风格,保
持一致和清晰的风格。
您不应该.. 不应该应用该规范或实践,除非有合理的理由。
您可以… 该标准和规范您可以按需应用。 该规范可用于编程风格,但不
总是有益的。
=15$0)#+,(
剩余51页未读,继续阅读
YJune
- 粉丝: 3
- 资源: 3
上传资源 快速赚钱
- 我的内容管理 收起
- 我的资源 快来上传第一个资源
- 我的收益 登录查看自己的收益
- 我的积分 登录查看自己的积分
- 我的C币 登录后查看C币余额
- 我的收藏
- 我的下载
- 下载帮助
会员权益专享
最新资源
- 2022年中国足球球迷营销价值报告.pdf
- 房地产培训 -营销总每天在干嘛.pptx
- 黄色简约实用介绍_汇报PPT模板.pptx
- 嵌入式系统原理及应用:第三章 ARM编程简介_3.pdf
- 多媒体应用系统.pptx
- 黄灰配色简约设计精美大气商务汇报PPT模板.pptx
- 用matlab绘制差分方程Z变换-反变换-zplane-residuez-tf2zp-zp2tf-tf2sos-sos2tf-幅相频谱等等.docx
- 网络营销策略-网络营销团队的建立.docx
- 电子商务示范企业申请报告.doc
- 淡雅灰低面风背景完整框架创业商业计划书PPT模板.pptx
- 计算模型与算法技术:10-Iterative Improvement.ppt
- 计算模型与算法技术:9-Greedy Technique.ppt
- 计算模型与算法技术:6-Transform-and-Conquer.ppt
- 云服务安全风险分析研究.pdf
- 软件工程笔记(完整版).doc
- 电子商务网项目实例规划书.doc
资源上传下载、课程学习等过程中有任何疑问或建议,欢迎提出宝贵意见哦~我们会及时处理!
点击此处反馈
安全验证
文档复制为VIP权益,开通VIP直接复制
信息提交成功
评论1