• 【日常】一名开发人员总结的好习惯,欢迎补充


    前言

    程序员对代码注释可以说是又爱又恨又双标……你是怎么看待程序员不写注释这一事件的呢?

    首先需要考虑(重要)

    设计和架构

    在开始编码之前,要对系统进行良好的设计和架构规划。这包括设计模式的应用、模块化设计、分层架构等。这样可以确保系统的可扩展性和可维护性。

    代码质量

    编写高质量的代码是每个Java开发工程师应该关注的重要问题。要遵循编码规范,保持良好的命名习惯、代码缩进、注释规范等。同时,要进行代码重构,消除重复代码、提高代码的可读性和可维护性。

    测试和调试

    编写单元测试和集成测试是保证代码质量的重要手段。要确保代码的正确性和健壮性,以及对错误情况的处理。同时,要能够进行有效的调试,快速定位和解决问题。

    性能优化

    Java开发工程师需要关注系统的性能,尽量减少资源的占用和提高系统的响应速度。这包括优化算法、减少内存泄漏、避免频繁的IO操作等。

    编程的好习惯

    代码可读性

    良好的命名习惯、代码缩进和注释规范可以使代码更易读懂,便于他人理解和维护。

    模块化和重用性

    将代码拆分为模块,提高代码的复用性和可维护性。可以通过面向对象的设计原则来实现。

    单一职责

    每个类和方法应该只负责单一的功能,遵循单一职责原则。这样可以使代码更加清晰和易于维护。

    异常处理

    合理处理异常,避免抛出未捕获的异常,保证系统的稳定性和可靠性。

    注释和文档

    良好的注释和文档可以帮助他人理解代码的意图和使用方法,提高代码的可维护性。

    常见的Java编码规范的例子

    1. 命名规范:
      • 类名使用首字母大写的驼峰命名法,如:MyClass。
      • 方法和变量名使用首字母小写的驼峰命名法,如:myMethod。
      • 常量名使用全大写,多个单词使用下划线分隔,如:MY_CONSTANT。
    2. 代码缩进规范:
      • 使用四个空格进行代码缩进,不使用制表符。
      • 在代码块之间添加空行,以增加可读性。
    3. 注释规范:
      • 使用Javadoc注释方式对类、方法和字段进行注释,提供清晰的文档说明。
      • 在代码中添加必要的行内注释,解释代码的意图和特殊处理。
    4. 异常处理规范:
      • 不要捕获异常后不做处理,至少应该记录日志或者抛出更具体的异常。
      • 尽量使用特定的异常类型,而不是使用通用的Exception。

    下面是一个示例代码,展示了一些编码规范的应用

    public class ExampleClass {
        
        // 常量名使用全大写,多个单词使用下划线分隔
        private static final int MAX_COUNT = 100;
        
        // 类名使用首字母大写的驼峰命名法
        public void myMethod() {
            // 使用四个空格进行代码缩进
            for (int i = 0; i < MAX_COUNT; i++) {
                // 在代码块之间添加空行
                if (i % 2 == 0) {
                    // 在代码中添加必要的行内注释,解释代码的意图和特殊处理
                    System.out.println("Even number: " + i);
                }
            }
        }
        
        /**
         * 方法的Javadoc注释,提供清晰的文档说明
         * @param name 参数的说明
         * @return 返回值的说明
         * @throws IllegalArgumentException 异常的说明
         */
        public String greet(String name) throws IllegalArgumentException {
            if (name == null || name.isEmpty()) {
                // 不要捕获异常后不做处理,至少应该记录日志或者抛出更具体的异常
                throw new IllegalArgumentException("Name cannot be null or empty");
            }
            
            return "Hello, " + name;
        }
    }
    
    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7
    • 8
    • 9
    • 10
    • 11
    • 12
    • 13
    • 14
    • 15
    • 16
    • 17
    • 18
    • 19
    • 20
    • 21
    • 22
    • 23
    • 24
    • 25
    • 26
    • 27
    • 28
    • 29
    • 30
    • 31
    • 32

    以上示例代码展示了一些常见的编码规范,包括命名规范、缩进规范、注释规范和异常处理规范。这些规范能够提高代码的可读性、可维护性和可靠性,使团队合作更加高效,并为后续的代码扩展和维护提供了便利。

    还有一些其他的编码规范值得注意

    1. 包名规范:
      • 包名应该以小写字母开始,多个单词使用点号分隔,如:com.example.myproject。
      • 避免使用Java关键字或常见的类库名称作为包名。
    2. 导入规范:
      • 避免使用通配符导入,尽量明确导入需要使用的类。
      • 将导入语句按照规定的顺序进行分组,如:Java标准库、第三方库、自定义库等。
    3. 并发编程规范:
      • 在多线程编程中,使用线程安全的数据结构或加锁机制来保护共享资源。
      • 避免使用过多的锁或不必要的同步,以提高性能和避免死锁。
    4. 性能优化规范:
      • 避免频繁的对象创建和销毁,尽量重用对象。
      • 使用StringBuilder或StringBuffer来拼接字符串,而不是使用"+"操作符。

    下面是一个继续展示编码规范的示例代码

    package com.example.myproject;
    
    import java.util.List;
    import java.util.ArrayList;
    import com.example.myproject.subpackage.MyClass;
    
    public class ExampleClass {
        
        private static final int MAX_COUNT = 100;
        
        public void myMethod() {
            List<String> myList = new ArrayList<>();
            
            for (int i = 0; i < MAX_COUNT; i++) {
                if (i % 2 == 0) {
                    System.out.println("Even number: " + i);
                }
            }
        }
        
        public String greet(String name) throws IllegalArgumentException {
            if (name == null || name.isEmpty()) {
                throw new IllegalArgumentException("Name cannot be null or empty");
            }
            
            return "Hello, " + name;
        }
        
        public void concurrentMethod() {
            synchronized (this) {
                // 在需要同步的代码块中使用锁来保护共享资源
            }
        }
        
        public void performanceMethod() {
            StringBuilder sb = new StringBuilder();
            
            for (int i = 0; i < MAX_COUNT; i++) {
                sb.append("Number: ").append(i).append("\n");
            }
            
            String result = sb.toString();
            System.out.println(result);
        }
        
        public static void main(String[] args) {
            MyClass myObject = new MyClass();
            // ...
        }
    }
    
    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7
    • 8
    • 9
    • 10
    • 11
    • 12
    • 13
    • 14
    • 15
    • 16
    • 17
    • 18
    • 19
    • 20
    • 21
    • 22
    • 23
    • 24
    • 25
    • 26
    • 27
    • 28
    • 29
    • 30
    • 31
    • 32
    • 33
    • 34
    • 35
    • 36
    • 37
    • 38
    • 39
    • 40
    • 41
    • 42
    • 43
    • 44
    • 45
    • 46
    • 47
    • 48
    • 49
    • 50

    以上示例代码展示了更多的编码规范,包括包名规范、导入规范、并发编程规范和性能优化规范。遵循这些规范可以提高代码的可读性、可维护性和性能,使代码更加规范、健壮和高效。

    总结

    作为一个Java开发工程师,以上是我对 好习惯 的一个较为浅显的理解,大家有更多的好习惯欢迎留言评论。

    如果大家遇到类似问题,欢迎评论区讨论,如有错误之处,敬请留言。

    在这里插入图片描述

  • 相关阅读:
    二进制文件解析系列-如何解析Android中的FLAT文件?
    AIDE:自动驾驶目标检测的自动数据引擎
    SpringBoot-JSR303数据校验
    (2022|TMLR,Parti,ViT-VQGAN,P2,樱桃树)扩展自回归模型以进行内容丰富的文本到图像生成
    IO学习系列之使用fgetc和fputc复制文件内容
    Python的安装与测试(windows为例)
    分割数组的最大值问题
    Kubernetes的四大特性
    中国书画院院士、著名画家——戴友
    学习笔记|ADC|NTC原理|测温程序|STC32G单片机视频开发教程(冲哥)|第十九集:ADC应用之NTC
  • 原文地址:https://blog.csdn.net/weixin_47264624/article/details/133761099