一份文档 50 多页,看都觉得很痛苦,只好放弃。最终经过一段时间探索之后得出了一个结论:编码规范只要解决问题就好,其他的尽量确保容易遵守就好。
编码规范解决的是什么问题呢?
减少项目交接时,由于代码风格水土不服所带来的风险。当某个项目人力不足时,可以减少加人时所带来的人力浪费(可以让一个人花更少的时间去看懂某个项目的代码)。防止项目过了一段时间一些实现自己都看不懂了。
以上当然要靠一个编码规范是无法完全解决的,除了编码规范之外,还有资源命名规范,项目结构规范等等。
经过多次因为以上原因的加班之后,深有感触。编码规范是非常有必要做的。
为自己制定一个编码规范
在公司,笔者还是最基础的员工,没有什么权利。所以对于定义规范这种事情,在公司想想就好了。不过这并不阻碍笔者为自己制定一个编码规范。于是笔者根据自己的编码习惯,定制了如下的编码规范。
/**************************************************************************** * Copyright (c) 2017 liangxieq * * https://github.com/liangxiegame/QCSharpStyleGuide * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal * in the Software without restriction, including without limitation the rights * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell * copies of the Software, and to permit persons to whom the Software is * furnished to do so, subject to the following conditio