程序员开发手册
程序员和编程员的区别安全生产信息化管理系统》程序员开发手册
1.概述
目的：
1.方便代码的交流和维护。
2.不影响编码效率，不与大众惯冲突。
3.使代码更美观，阅读更方便。
4.使代码逻辑更清晰，更易于理解。
范围：
本手册适用于开发部全体人员，在软件项目开发的代码编写和后期维护阶段起作用。
警示：
对于不符合编码规范的代码，必须在限期内修正。逾期视为工作过失，部门主管或相关负责人视具体情况做出相关处理。
术语定义：
1.匈牙利命名法已被禁用。
2.推荐使用帕斯卡（pascal）命名法或骆驼(Camel)命名法。
2.代码格式
列宽：
1.为了防止在阅读代码时不得不滚动源代码编辑器，每行代码或注释在一般显示频率下不得超过一显示屏，代码列宽控制在110字符左右。
2.系统中部分代码可以不遵循此原则，比如VIWFormItemDetail[]dv=(VIWFormItemDetail[]),sqlParams)。
3.SQL语句拼接、字符串拼接、函数参数名过长、判断语句过长的代码要遵循以上原则。
换行：
1.当表达式超出或即将超出规定的列宽，一行被分为几行时，通过将串联运算符放在每一行的末尾而不是开头，清楚地表示没有后面的行是不完整的。例如：StringquerySql=“SELECTProjectId”+“,ProjectTitle”+“FROM Project”。
2.每一行上放置的语句避免超过一条。
3.当表达式超出或即将超出规定的列宽，遵循以下规则进行换行：
1) 在逗号前换行。
2) 在操作符前换行。
3) 规则1优先于规则2.例如：StringBuilder querySql = new StringBuilder();("SELECT。AS PK ");(",",",");("。AS ISBNCode");
在编写代码时，应该遵守一定的格式规范，以提高代码的可读性和可维护性。
首先，缩进应该使用四个空格，而不是制表符。这样可以避免在不同的编辑器和环境中出现混乱的缩进。
其次，空行应该用于分隔逻辑上相关的代码块。例如，在接口和类、枚举和类、以及类与类之间应该使用两个空行。而在方法与方法、属性与属性、方法中的逻辑块之间、以及注释与它注释的语句之间应该使用一个空行。
此外，在关键字和左括号“(”之间应该使用空格隔开，而在方法名和左括号“(”之间不应该使用空格。同时，在二元操作符和操作数之间应该使用空格隔开。
在使用括号时，左括号“(”应该与关键字或方法名之间用一个空格隔开，而左花括号“{”应该放在关键字或方法名的下一行并与之对齐。同时，左花括号“{”应该与相应的右花括号“}”对齐，并且通常情况下左花括号“{”应该单独成行。
最后，在if、while、do语句中一定要使用{}，即使{}号中为空或只有一条语句。这样可以避免出现逻辑错误和代码混乱的情况。
If (someValue == 1) {
XXX 2;
建议加注释
到与之相应的{
while (1) {
if (valid) {
XXX用于方法内的代码注释
建议使用Xml标签注释来标记接口、类、方法、属性、字段
每行声明一个变量，并按字母顺序排列
int level;
for (int i = 0.i < maxLoops。i++) {
避免不同层次间的变量重名
int count;
void MyMethod() {
if (n) {
int count = 0;
类和接口的声明
方法名与左括号间没有空格，左花括号单独成行并与声明对齐，方法间用一个空行隔开
不要使用public或protected的实例字段，考虑使用get和set属性访问器来访问字段
public class Control : Component {
private int handle;
public int Handle {
get {
return handle;
遵循命名规范来命名变量、方法、类、接口、字段等
Names should describe "what" rather than "how"。By XXX (which may change)。XXX。For example。we can use GetNextStudent() instead of GetNextArrayElement()。The naming principles are:
版权声明：本站内容均来自互联网，仅供演示用，请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198，我们将在24小时内删除。
发表评论