良好的程序设计风格是成功的一半

       良好的程序设计风格是成功的一半

       曾经,老师一次又一次的告诫我们,要有良好的程序设计风格,直到,与他人一起协作开发一款小软件时,看不懂别人写的代码(没有注释,书写混乱),才深刻理解了老师的话!

       现在回头看自己曾经写过的程序,看到那些没有加注释,书写混乱的代码,自己都想吐了!幸好,老师曾经强制要求我们加注释,养成良好的程序设计风格。在这一点上,真心感谢老师!

       现在的软件都不是一个人开发出来的,都需要多人协作开发,因此,养成好的程序设计风格,才会有人愿意与你合作,也才能更好的与他人协作完成任务。最近,与几个同学协作开发一款小游戏,经过3、4个星期断断续续的开发,最终较好的完成了它,这也是java的期中作业啊!在这个过程中,我作为组长,还算尽职尽责吧!我负责软件的整体架构及主模块,采用MVC的架构(此处逐渐感受到好的架构对于更好的应对需求变化是多么重要啊!)。在这个过程中,自己学到了很多东西,也感受良多!现在将自己的一些小经验与大家分享!有错误或不妥之处,请大家指正!

       在本次的游戏开发中,当我看到一个小组成员写的代码时,我不得不感慨:设计风格真的很重要啊!他的代码中,看不到注释,书写混乱,变量的命名看不懂!

      因此,在编程时,拿java来说:

      第一,写的程序一定要打包,每次新建一个工程,先建包,将自己的程序进行分层处理,比如:主程序写在一个包中,而另一个包中负责测试,将测试代码与主代码分开。这一点很重要,对于你以后的管理都会有很大的帮助!我在设计那个游戏时,采用MVC的架构,首先,将整个工程分为三个大包(即:UI包(只负责界面的显示)、Business大包(负责核心的业务逻辑)、DataAccess包(负责数据的存取访问)),这样整个工程管理起来很清晰,界面设计就只在UI包中进行,管理方便。

      第二,类、变量的起名,一定要做到见名知意,有时写长一点都行!(此处,我想说:英语学好真的很重要,至少给变量起名很方便)。强烈不建议用汉语拼音起变量名。例如:如果是界面的显示类,是继承自frame,那就以Frm结尾,若是继承自Dialog,那就以Dlg结尾。用J开头比较好,C++中常用C开头的!(JMainMenuFrm),每一个单词的首字母大写,类名的首字母一般大写,这样,你看到以Frm结尾,你就知道他是负责显示界面的,不用其他的注释,就能知道他的功能和作用,非常便于管理。再说变量的起名,如果是常量,一般都大写,如:COUNT,如果是boolean变量,以is开头,如:isRun,这样,你就知道这是boolean型变量。

      第三,每一个类,都要写类注释,尽量用文档注释(/**    */),这样做最后可以到出文档注释。每一个方法都要写其作用、参数及返回值的说明等(用文档注释),每个方法的算法的核心部分加注释,不建议每一句代码都加注释,那样反而会感到很乱,但,至少保证你加的注释,能过便于自己和别人理解。

      然后,再说一下MVC架构,本游戏中我逐渐体会到它的强大之处。举个例子,在DataAccess包中,我写了读取图片的类(LoadImage),刚开始,使用了默认的路径,在bin的路径下,但有时,重写编译时发现,那个图片资源的文件莫名其妙的不见了,这让人很不爽,我想将它的路径改在当前工程下,此处,Business包中访问的代码都写好了,但我不用改其中任何代码,甚至不需要打开Business包中的访问类,只将在DataAccess包中LoadImage类的访问路径一改就OK了,即体现了代码的复用性,又很好的应对变化,如果你将访问图片与业务逻辑处理及显示都写在一起,那将很难管理。所以,学会用这样的分层管理思想。

      最后,我想说的是,学会与人协作真的很重要,如果在一个团队中,能够发挥每个人的优势,那就能实现1+1 >2的效能,集体的智慧毕竟远大于个人的智慧。与人协作是一门学问,值得我们思考和学习。在软件的开发中,充分的沟通很重要,既能了解的需求,又能与其他成员更好的协作。

转载请标明出处:http://blog.csdn.net/u012027907

以下是我们的游戏截图,以后我会在博客中详细说明它的设计过程及核心代码。

《良好的程序设计风格是成功的一半》

《良好的程序设计风格是成功的一半》《良好的程序设计风格是成功的一半》

此游戏中,使用了《恶魔杀手》游戏中的图片资源,此游戏只是学习交流,希望没有侵权!

转载请标明出处:http://blog.csdn.net/u012027907点击打开链接

    原文作者:牟尼
    原文地址: https://blog.csdn.net/u012027907/article/details/17042995
    本文转自网络文章,转载此文章仅为分享知识,如有侵权,请联系博主进行删除。
点赞