几个祖传代码不遵守就想骂的代码规范("不得不遵守的祖传代码规范：避免引发吐槽的编程准则")

原创

ithorizon 7个月前 (10-20) 阅读数 17 #后端开发

祖传代码规范：避免引发吐槽的编程准则

一、命名规范：明确、简洁、具有描述性

祖传代码中，命名规范是引发吐槽的重灾区。以下是一些不得不遵守的命名准则：

1. 变量命名

变量名应具有描述性，明确表达其代表的含义。避免使用拼音、缩写或无意义的字母组合。


// 不良示例
int a, b, c;
String str1, str2;
// 推荐示例
int number1, number2;
String firstName, lastName;

2. 函数命名

函数名应描述函数的功能，采用驼峰命名法。


// 不良示例
void test();
void doSomething();
// 推荐示例
void calculateSum();
void printUserInfo();

3. 类命名

类名应采用大驼峰命名法，表达其代表的实体或功能。


// 不良示例
class user {
    // ...
}
class myClass {
    // ...
}
// 推荐示例
class User {
    // ...
}
class Calculator {
    // ...
}

二、代码格式：整洁、一致、易于阅读

代码格式是祖传代码中另一个容易引发吐槽的地方。以下是一些格式规范：

1. 缩进与换行

使用4个空格进行缩进，保持代码整洁。避免在同一行写多个语句。


// 不良示例
int a = 1;
int b = 2;
// 推荐示例
int a = 1;
int b = 2;

2. 代码块

大括号应独占一行，代码块内部采用4个空格缩进。


// 不良示例
if (a > b) {
    // ...
}
// 推荐示例
if (a > b) {
    // ...
}

3. 注释

注释应简洁明了，描述代码块或函数的功能。避免过度注释。


// 不良示例
int sum = a + b; // 计算a和b的和
// 推荐示例
int sum = a + b; // 计算两个整数的和

三、代码结构：模块化、解耦、复用

代码结构对于祖传代码的可维护性至关重要。以下是一些结构规范：

1. 模块化

将功能相似的代码组织在一起，形成模块。模块之间尽量保持自由，便于维护。


// 不良示例
public class User {
    public void login() {
        // ...
    }
    
    public void logout() {
        // ...
    }
    
    public void calculateSum() {
        // ...
    }
}
// 推荐示例
public class User {
    public void login() {
        // ...
    }
    
    public void logout() {
        // ...
    }
}
public class Calculator {
    public void calculateSum() {
        // ...
    }
}

2. 解耦

尽量避免代码间的直接依赖性，使用接口、抽象类等设计模式降低耦合度。


// 不良示例
public class UserService {
    public void login(User user) {
        // ...
    }
}
// 推荐示例
public interface UserService {
    void login(User user);
}
public class UserServiceImpl implements UserService {
    public void login(User user) {
        // ...
    }
}

3. 复用

避免重复编写相同的代码，尽量使用继承、组合等手段实现代码复用。


// 不良示例
public class User {
    private String name;
    private int age;
    // ...
}
public class Admin {
    private String name;
    private int age;
    // ...
}
// 推荐示例
public class Person {
    private String name;
    private int age;
    // ...
}
public class User extends Person {
    // ...
}
public class Admin extends Person {
    // ...
}

四、代码优化：性能、可读性、平安性

代码优化是尽大概减少损耗祖传代码质量的关键。以下是一些优化准则：

1. 性能优化

在保证功能正确的前提下，尽量尽大概减少损耗代码的执行高效能。


// 不良示例
for (int i = 0; i < list.size(); i++) {
    // ...
}
// 推荐示例
for (int i = 0, size = list.size(); i < size; i++) {
    // ...
}

2. 可读性优化

通过合理的命名、注释和代码结构，尽大概减少损耗代码的可读性。


// 不良示例
int a = 1, b = 2, c = 3;
// 推荐示例
int number1 = 1;
int number2 = 2;
int number3 = 3;

3. 平安性优化

在编写代码时，注意防范潜在的平安风险，如SQL注入、跨站脚本攻击等。


// 不良示例
String sql = "SELECT * FROM users WHERE username = '" + username + "' AND password = '" + password + "'";
// ...
// 推荐示例
String sql = "SELECT * FROM users WHERE username = ? AND password = ?";
// ...