自己总结的C#编码规范--7.文档下载及总结

今天终于把这一系列的编码规范写完了,这个编码规范算上前面阅读相关书籍,前前后后总共花了一个月的时间,也算是个人的呕心沥血之作了。

本来也没打算把这个系列写的这么长,但是在写的过程中自己搜了相关的网上资料,后来发现网上的c#代码规范很少,而且仅有的几份都很泛泛,没有实际的内容。所以自己就阅读了相关的书籍,自己结合自己几年来的开发经验写了这份文档。希望可以帮助那些苦于没有编码规范的程序员,也希望所有新程序员能在职业生涯的初期就有一个良好的编码习惯,这对于以后个人的成长有至关重要的作用。

在写这个规范的时候感觉自己代码的能力也提高了不少,尤其是对命名和注释方面也有了不少自己的见解。

现在把这一系列规范的完整文档共享给大家。希望大家看在一个月辛勤劳动的份上给点个赞。 :-)

C#编码规范文档下载

希望大家在看完文档后觉得有需要继续添加的或不对的地方给予指正。也欢迎大家在相应的章节里评论讨论。

相应章节

1.命名规范

1.1 命名约定篇

1.2 命名选择篇

1.3 特定场景下的命名最佳实践篇

2. 注释

2.1 注释约定篇

2.2 不需要的注释篇

2.3 需要的注释篇

2.4 如何写好注释

3. 格式

4. 文档下载 & 总结

感觉写博客还是受益蛮大的,而且和博友们讨论还能覆盖一些以前自己没有想到的问题。道理也是越辩越清。

以后还会继续努力的写博。应该都是些新研究的技术方向的博客。

自己总结的C#编码规范--7.文档下载及总结

时间: 2024-10-29 04:26:22

自己总结的C#编码规范--7.文档下载及总结的相关文章

自己总结的C#编码规范--7.文档下载 & 总结

今天终于把这一系列的编码规范写完了,这个编码规范算上前面阅读相关书籍,前前后后总共花了一个月的时间,也算是个人的呕心沥血之作了. 本来也没打算把这个系列写的这么长,但是在写的过程中自己搜了相关的网上资料,后来发现网上的c#代码规范很少,而且仅有的几份都很泛泛,没有实际的内容.所以自己就阅读了相关的书籍,自己结合自己几年来的开发经验写了这份文档.希望可以帮助那些苦于没有编码规范的程序员,也希望所有新程序员能在职业生涯的初期就有一个良好的编码习惯,这对于以后个人的成长有至关重要的作用. 在写这个规范

PHP 高级程序设计(1) - 编码规范及文档编写

PHP 高级程序设计学习笔记20140612 软件开发中的一个重要环节就是文档编写.他可以帮助未来的程序维护人员和使用者理解你在开发时的思路.也便于日后重新查看代码时不至于无从下手.文档还有一个重要的作用,在不用了解要访问对象的细节情况下也能很好的在对象之间进行交互.文档的编写有一些成熟的行业标准格式,遵守这些行业标准将有助于创建易于阅读的代表,并使自动生成手册成为可能. 编码规范 编码规范可能很多开发人员都有各自的观点也意见,且大家不尽相同.其实只要团队成员之间达成一致,遵循同一个标准就好.

iOS编码规范(文档)

文件命名规范: 1. 项目统一使用类前缀ZY. 2. 分类命名+后面统一使用ZYExtension,例:NSDictionary+ZYExtension.h,常用分类定义在内部并写好文档注释.如果功能性分类内部方法较多可以考虑按功能命名. 3. model文件可按服务器接口名或字段名命名,view.viewModel和controller文件可按功能命名. 4. 切图命名:home_menu_chat,->模块_功能_具体名字,切图命名很重要,这点可与美术沟通,让他们直接命名好再给我们,可以大大

数据分析临时需求处理规范及文档管理

ps: 转自2014-11-04  数据海洋                       BI临时需求处理规范及文档管理内容一.目的规范BI处理的临时需求.便于部门同事了解业务以及借鉴. 二.临时需求的定义由业务部门向BI提出的一次性数据需求.主要用亍解决业务方某个点的问题. 三.文档的内容在临时需求处理完成后,完成以下内容,放入到共享文件夹中. 各个内容项说明需求目的:这个需求要解决业务方什么问题需求内容:指给出数据字段.规则.需求提交人:由业务部门谁向BI提交的该需求数据使用人:业务部门谁是

将Html文档整理为规范XML文档

有多种方式可以在.NET 平台进行HTML文件解析.数据提取,其中最简单.稳妥的办法是先使用工具将Html文档整理成XML文档,再通过XML Dom模型或XPath灵活地进行数据处理.SGML便是一个Html文档整理工具类库: Microsoft的XML大师Chris Lovett专门开发了一个SGML解析器,叫做SgmlReader,它可以解析HTML文件,甚至将它们转换成一个格式规范的结构. SgmlReader派生于XmlReader,这就是说,你可以像运用诸如XmlTextReader这

Java开源生鲜电商平台-技术方案与文档下载(源码可下载)

说明:任何一个好的项目,都应该有好的文档与设计方案,包括需求文档,概要设计,详细设计,测试用例,验收报告等等,类似下面这个图: 有以下几个管理域: 1. 开发域. 2. 管理域 3. 基线域 4. 产品域 1.  开发域包括以下几个维度: 例如:需求开发中,应该包括以下几个文档: 2,系统设计中又包括: 3. 基线域 其中需求基线又包括: 化状态:A--增加,M--修改,D--删除 目录 1       项目简介..........................................

35、生鲜电商平台-技术方案与文档下载

说明:任何一个好的项目,都应该有好的文档与设计方案,包括需求文档,概要设计,详细设计,测试用例,验收报告等等,类似下面这个图: 有以下几个管理域: 1. 开发域. 2. 管理域 3. 基线域 4. 产品域 1.  开发域包括以下几个维度: 例如:需求开发中,应该包括以下几个文档: 2,系统设计中又包括: 3. 基线域 其中需求基线又包括: 化状态:A--增加,M--修改,D--删除   目录 1       项目简介........................................

[Java] Java API文档下载方法

Java API文档下载方法:http://jingyan.baidu.com/article/a3aad71ac9e48fb1fb009692.html Oracle : http://www.oracle.com/index.html

斯巴鲁汽车 技术文档下载方法

昨天深夜,突然朋友找我帮忙,下载斯巴鲁的技术文档.原本以为是因为某些原因他访问不到国外的网站,结果却让我惊呆了!妈蛋,这pdf有1000多个啊··· 朋友在国外的论坛上找到有人可以下载,而且已经贴上了源码,只是他不懂. 论坛地址为:http://www.subaruoutback.org/forums/138-gen-5-2015-present/280682-2016-owner-s-service-manuals-posted.html 这是文档下载的网站:http://techinfo.s