其他分享
首页 > 其他分享> > 【简单明了写代码】让你的代码一目了然

【简单明了写代码】让你的代码一目了然

作者:互联网

 之前给大家讲了很多的Java入门路线和java面试题-不知道伙伴们有没有规范自己写得代码?

今天给大家找了,如何写出一目了然的代码?

 

 不会写的同学,没有基础的同学,可以观看B站的Java300集学习Java基础>>>

 

代码风格虽然不影响程序的运行,但对程序的可读性却非常重要。自己编写的程序要让别人看懂,首先在排版方面要非常注意。

其实每个人的编程风格、每个软件开发公司的编程风格都不一样。一个人编写的程序代码,就应该能让别人看懂,甚至是过了很长时间,自己也要看的懂,否则这个程序就成了一个死程序。

编程风格是指编程时的格式,让程序看上去就很有层次感。下面通过一些例子,说明编程风格的重要性:

public class math{
    public static void main(String[] args){
        int x=12;
        double y=12.3d;
        void print(){
            char a='a';
            System.out.println(a);
        }
        System.out.println(x+y);
    }
}

上面程序段的整个排版看起来是否很舒服,并且层次感很强?是否一眼看上去就知道整个程序架构?这里的关键在于缩进,缩进也可以称为跳格。

上面的代码采用的缩进:"public class math" 是顶格的,接着 mian() 方法缩进 4 个空格,在 mian() 方法里面的代码一律缩进 8 个空格,而 print() 方法的主体代码又多缩进 4 个空格。这样整个程序的所属关系就很明显了。mian() 方法属于 math 类,其余的都属于main() 方法,而在 print() 方法内的代码段又属于此方法。规律就是空格多的代码从属于空格少的代码。

我推荐大家使用 tab 键缩进,大部分编辑器(如Eclipse)都支持自定义 tab 键的空格数,一般为 4 个空格。

除了缩进,空行也是必要的,先看下列程序代码:

public class math{
    public static void main(String[] args){
        int x=12;
        int y=23;
        void print(){
            // .................
        }
        void view(){
            // ....................
        }
    }
}
上面的程序段,在 print() 方法与 view() 方法之间有空行,用来区分不同的模块。print() 方法与 view() 方法所完成的功能不一样,所以使用空行将它们分开,这样更增加了程序的可读性。

另外,需要注意的是方法或属性的命名。这些名字应该有含义,最好有规律,不要只使用"a"、"b"这种通用变量,适当可以根据变量或函数的功能为其命名。上面的"print",其他程序员一看就知道这个方法,是有关打印或输出的函数。再如:变量名"name",一看就知道是有关名字的变量。所以,一定要命名的有意义,否则程序的可读性不强。

还有一点是有关注释的。在每个方法的方法名旁边,应该添加一些注释,同时在一段程序完成之后,也要对程序的功能及如何操作,做个简单的描述。

只要做到以上几点,这个程序他人来读就很容易。即使自己在很长时间后,再来读程序也会一目了然。

注意了!!!

不会写的同学,没有基础的同学,可以观看B站的Java300集学习Java基础>>>

 


标签:缩进,代码,程序,空格,简单明了,一目了然,print,方法
来源: https://www.cnblogs.com/xzwbk/p/15434167.html