• 分析一套源代码的代码规范和风格并讨论如何改进优化代码


    分析一套源代码的代码规范和风格并讨论如何改进优化代码

    1、结合工程实践选题相关的一套源代码,根据其编程语言或项目特点,分析其在源代码目录结构、文

    件名/类名/函数名/变量名等命名、接口定义规范和单元测试组织形式等方面的做法和特点。

    代码的目录结构如下图所示:

    目录结构比较清晰,文件包命名也很符合规范。

     


    2、列举哪些做法符合代码规范和风格一般要求。

    以下面代码为例,简单介绍下其符合代码规范和一般要求之处:

    1、符合类的命名规范,即:类名必须遵循大写字母开头的驼峰式命名方式(UpperCamelCase)。

    2、注释的缩进与其上下文保持一致,使用了/* ... */和//的风格。多行的注释中*也对齐了。

    3、使用了注释,增强了代码的可读性。

    4、花括号的使用遵循了 K&R 风格(Kernighan and Ritchie Style):

      a.左花括号({)前不能换行,在其后换行。

      b.在右花括号(})前要有换行。

      c.如果右花括号是一句语句、一个方法、构造函数或非匿名类的结尾,其后需要换行。

    5、符合方法的命名规范,即:方法必须遵循小写字母开头的驼峰式命名方式(lowerCamelCase)。

    6、符合变量的命名规范,即: 变量(类变量和实例成员变量)名必须采用小写单词驼峰命名方式

    (lowerCamelCase)。

    7、符合参数的命名规范,即:参数名必须采用小写单词驼峰命名方式(lowerCamelCase)。

    8、缩进使用是4个空格而不是Tab。

    9、符合通用命名规范,所有的标识符只使用了ASCII字符和数字,且没有使用中文拼音来命名。

    10、每行只写一条语句,每条语句之后都换行了。

     

    不规范之处:

    1、需严格限制使用单字符命名参数,尽量不使用单字符命名参数x、y、w、h。


    3、列举哪些做法有悖于“代码的简洁、清晰、无歧义”的基本原则,及如何进一步优化改进。

    该代码结构比较清晰,符合软件工程中高内聚低耦合的原则,不足之处就是,注释较少不便于其他人

    员理解代码,还有上文中所提到的,尽量不使用单字符命名参数。


    4、总结同类编程语言或项目在代码规范和风格的一般要求。

    我理解的Java代码规范和风格的一般要求简单总结如下:

    1、骆驼法则:Java中,除了包名,静态常量等特殊情况,大部分情况下标识符使用骆驼法则,即单词

    之间不使用特殊符号分割,而是通过首字母大写来分割。

    2、尽量使用通俗易懂的英文单词,如果不会可以向百度,尽量不要使用汉语拼音,以免歧义。

    3、每个if、else、 while、for等判断循环后的语句,都不要省略花括号{ },以便于理解代码。

    4、缩进尽量使用空格,避免使用Tab。

    5、花括号的使用要遵循 K&R 风格。

    6、不要再对boolean值做true false判断。

    。。。

  • 相关阅读:
    C#面向对象(二)之抽象类实现多态
    JavaWeb 学习0010-今日问题 2016-12-3
    JavaWeb 学习008-今日问题(非空验证尚未解决) 2016-12-2
    JavaWeb 学习007-4个页面,5条sql语句(添加、查看、修改、删除)2016-12-2
    JavaWeb 学习006-4个页面,5条sql语句(添加、查看、修改、删除)
    JavaWeb 学习005-4个页面,5条sql语句(添加、查看、修改、删除)
    JavaWeb 学习004-增删改查的编写
    JavaWeb 学习003-简单登录页面功能实现
    JavaWeb 学习001-登录页面-Servlet
    JavaWeb 学习001-登录页面
  • 原文地址:https://www.cnblogs.com/LiScott/p/11662961.html
Copyright © 2020-2023  润新知