精华内容
下载资源
问答
  • 代码设计应遵循哪些原则

    千次阅读 2018-09-06 13:59:58
    2.3 建议遵循30秒原则。如果另一个程序员无法在三十秒内无法知道你函数在做什么,如何做以及为什么要这样做,那么说明你的代码是难于维护,需要得到提高。 2.4 一个函数的代码长度不允许超过100行,超过一百行...

    1提高编码质量,代码可读性和可维护性。

    2代码编写规范

    2.1 删除所有无用代码
    2.2 必须给代码添加注释,一个类的注释字数不得小于代码的百分之20%
    2.3 建议遵循30秒原则。如果另一个程序员无法在三十秒内无法知道你的函数在做什么,如何做以及为什么要这样做,那么说明你的代码是难于维护的,需要得到提高。
    2.4 一个函数的代码长度不允许超过100行,超过一百行的函数建议在不破坏原子性的基础上进行拆分。
    2.5 变量都应在方法或者类的头部集中定义
    2.6 保证一行代码只做一件事
    2.7 使用括号来控制操作符的运算顺序,以免使用java默认的操作符优先级顺序。
    2.8 代码格式化:对代码进行格式化,再进行提交。
    2.9 接口不允许没有方法或者变量的声明

    1. 命名规范
      3.1 各种标识符的命名要使用有实际意义的英文单词或者英文单词缩写,缩写词及英文单词要收录在项目的简写词汇表中。切忌使用阿拉伯数字和拼音进行命名。
      3.2 类名:首字母大写,每个单词首字母都需要大写。
      3.3 方法名:首字母小写,其余单词首字母都需大写。
      3.4 全局变量,和常量名称要求全部字母大写。
      3.5 参数名称与局部变量基本相同,区别在于参数名称需要加上冠词a ,an 或者在单词结尾以s结束。

    2. 注释规范
      4.1 注释需要注意的事项:
      ★注释应该用中文清晰表达意思,应该是程序看起来更清晰,更容易理解
      ★注释要尽量简明,避免装饰性的注释。
      ★注释不但要说明做什么,还应当说明为什么要这样做。最好先写注释表明要做什么,再进行编码。

    4.2 类的注释
    ★类的用途,目的。包括其他人感兴趣的介绍。
    ★已知bug,当然最好是修改好所有的错误,但有时可能暂时没有办法修改,或者没有时间修改。
    ★开发和维护该类的历史列表,记录每一次修改的作者,日期,修改的内容。
    ★列举类的各种稳定状态,说明调用成员函数使类的状态产生的变迁(可选)。
    ★同步问题(可选)
    ★对主要的算法必须加以说明,主要流程必须给予引导性说明
    标准格式:
    如果对已经版本话的类进行了修改,需要按照如下格式为每一次修改附加修改历史记录:
    // 修改人 + 修改日期
    // 修改说明 范例:

    // 李四 2010/07/02
    // 添加错误数据修改后继续批量保存的处理函数 saveBatch(
    @Bind(key = “itemParams”, defaultValue = “”) String itemParams,
    @Bind(key = “pid”, defaultValue = “”) String pid)。
    // 王小二 2010/07/02

    4.3 接口注释:
    ★接口的注释风格基本与类的注释风格相同;
    ★在别人使用接口之前,必须了解接口所包含的概念。检验一个接口是否应该定义的简单方法是:你是否能★够容易的描述接口的用途;
    ★接口如何应当和不应当被使用。开发者需要知道该接口如何被使用,也希望知道该接口不能被怎样使用。

    4.4 函数的注释
    ★函数头注释必须包括:函数执行了什么功能,为什么要这样处理;函数处理过程中对对象的哪些属性
    ★可能进行更改;函数执行前后,对象的状态;
    ★比较、循环等控制结构加注释(可选);
    ★在代码的功能并非一目了然的情况下,应当说明为什么要这样做;
    ★局部变量必须加注释;
    ★复杂难写的代码必须加注释;

    4.5类属性的注释:
    ★描述域的用途。使别人知道如何去使用它;
    ★对于有着复杂事物规则的域,可以加入范例来说明。有时候一个简单的小例子,抵的上千言万语;

    展开全文
  • 用实例域代表一个接口,然后将行为封装进接口族中,再组合进代码中,这样的代码既灵活也可以复用。 找出程序中不会变和会变,然后相分离。 接口对于解耦合也很有用处。 对于类之间数据传递,最好也是封装起来...
    • 在大多数情况下,接口都是比继承更优的选择。尤其是对于Java这类单继承语言。

    • 多用组合(has a),少用继承(is a)。用实例域代表一个接口,然后将行为封装进接口族中,再组合进代码中,这样的代码既灵活也可以复用。

    • 找出程序中不会变的和会变的,然后相分离。

    • 接口对于解耦合也很有用处。

    • 对于类之间的数据传递,最好也是封装起来,以保证后期的良好扩展。

    • 同接口也可以进行适当的分离以解耦合,比如将获取数据(GetData)和显示数据(Display)分属于两个接口让类去实现,而不是揉和在一起。

    • flag域可用来表示状态,考虑要不要做该不该做时多用flag域。

    • 类应该对扩展开放,对修改关闭。

    • 避免变量持有具体类的引用;避免类派生自具体类;避免覆盖基类中已实现的方法。

    • 要依赖抽象,不要依赖具体类。

    转载于:https://www.cnblogs.com/seliote/p/9313075.html

    展开全文
  • 一、门户网站开发应遵循的原则 1、门户网站最重要的就是用户体验,从开端制造的时分就要做好用户定位。因而在设计网站,制造网页以及编写代码、调试网站的时分等,都要谨记着一点:假如没有用户来阅读网站,那么这个...

    门户网站是一种综合性的信息平台,同时提供相关的信息服务。一般门户网站都是较大型的网站,例如搜狐、新浪等。如果我们要进行门户网站开发,应当遵循哪些原则呢?美工铺子小编整理了如下内容,供大家参考。
    门户网站开发

    一、门户网站开发应遵循的原则
    1、门户网站最重要的就是用户体验,从开端制造的时分就要做好用户定位。因而在设计网站,制造网页以及编写代码、调试网站的时分等,都要谨记着一点:假如没有用户来阅读网站,那么这个网站就是做得没有价值,因而需求时辰将用户的体验摆在最首要的位置上。

    2、如今互联网上的阅读器软件十分多,假设想让一切用户都能够随意运用任何阅读器翻开网站,对网页停止阅读,因而需求充沛思索开发的门户网站和各种阅读器间兼容的性能,在网站中防止用HTML这样只要一局部的阅读器才干支持的格式,要运用一切阅读器都能停止阅读的格式,并在网站上应用上能保证兼容的技术。

    3、假设是开发企业的门户网站普通运用办公室的网线,假设是学校的门户网站那么就要运用高速的专线网。因而,不论是做什么类型的门户网站,都需求思索好网站运转的网络环境,关于那些网速不太快的网站,在设计时就应该充沛的思索,不要在网页上添加太多会形成访问网站速渡过慢的元素,在完成后还应该实地停止充沛的测试才干上线。

    4、门户网站的规划工作,做每件事前都要先停止规划,特别是开发门户网站要做好这点,关于网站有什么特性、性质等都要提供哪些内容。功用、网站的目的用户又是哪些,只要先弄明白这些才干做好规划,才干开发出效果比拟好的门户网站来。

    5、不论是企业的还是学校等的门户网站,其可以提供的内容都是综合性比拟强的,因而对内容的质量有着比拟高的请求,要是一个门户网站的内容都是复制粘贴他人的内容,这关于用户来说就失去了门户的意义,因而想要开发门户网站一定要保证内容的质量。

    展开全文
  • 软件开发应该遵循的一些核心原则: Don’t Repeat Yourself: 这是软件开发的一个基础原则,即不要做重复性劳动。也是现在所说的“极客文化”的一种。代码重复、工作重复在软件开发中都是不合理的存在。利用各种手段...

    软件开发应该遵循的一些核心原则:

    Don’t Repeat Yourself: 这是软件开发的一个基础原则,即不要做重复性劳动。也是现在所说的“极客文化”的一种。代码重复、工作重复在软件开发中都是不合理的存在。利用各种手段消除这些重复是软件开发的一个核心工作准则。

    Keep it simple stupid:即KISS原则。在做软件设计的工作中,很多时候都不要想得过于复杂,也不要过度设计和过早优化,用最简单且行之有效的方案也就避免了复杂方案带来的各种额外成本。既有利于后续的维护,也利于进一步的扩展。

    You Ain’t Gonna Need It: 即YAGNI原则。只需要将应用程序必需的功能包含进来,而不要试图添加任何其他你认为可能需要的功能。因为在一个软件中,往往80%的请求都花费在20%的功能上。

    Done is better than perfect: 在面对一个开发任务时,最佳的一个思路就是先把东西做出来,再去迭代优化。如果一开始就面面俱到,考虑到各种细节,那么很容易陷入牛角尖而延误项目进度。

    Choose the most suitable things: 这是在做方案选择、技术选型时候的一个很重要的原则。在面对许多技术方案、开源实现的时候,务必做到的是不能盲目求新,要选择最合适的而非被吹得天花乱坠的。

    展开全文
  •  无论系统是采用电池供电还是由市电供电,应用需求将决定存储器类型(易失性或非易失性)以及使用目的(存储代码、数据或者两者兼有)。另外,在选择过程中,存储器尺寸和成本也是需要考虑重要因素。对于较小...
  • 设计模式实现遵循了一些原则,从而达到代码的复用性及增加可维护性目的,设计模式对理解面向对象三大特征有很好启发,不看设计模式,很难深层地体会到面向对象开发带来好处 。在刚开始学习中,很难做到将...
  • JQuery遵循原则

    2018-08-06 09:51:32
    由于 jQuery 是为处理 HTML 事件而特别设计的,那么应遵循以下原则时,代码会更恰当且更易维护: 把所有 jQuery 代码置于事件处理函数中 $("button").click(function() {..some code... } ) 把所有事件...
  • 众所周知,Java编程最基本的原则就是要追求高内聚和低耦合的解决方案和代码模块设计。查看Apache和Sun的开放源代码能帮助你发现其他Java设计原则在这些代码中的实际运用。Java Development Kit则遵循以下模式:...
  • 代码设计规范

    2021-01-22 09:03:43
    遵循“先设计后开发”的原则设计高于开发 设计确定好时序图、UML关系图 设计将需求、场景抽象成模型(建模),并将模型拆分成模块,形成架构 模型考虑并兼容后续需求的迭代开发,减少架构的修改 ...
  • 比如:数据库表结构和索引、设计缺陷可能带来软件上架构缺陷或性能风险、工程结构混乱导致后续维护艰难、没有鉴权漏洞代码易被黑客攻击等等。 那这样话,我们在项目开发过程中,就需要要更加优秀程序猿...
  • 停车场门禁管理系统设计原则及目标 一:停车场门禁管理系统设计原则 根据停车场门禁管理需求和我们对此次停车场现场勘查,设计过程中遵循以下原则: 1.园内所有车位均为固定用户车位,花园内停车场原则上不允许...
  • 在开发过程当中,如何提高软件可...一个软件实体应当对扩展开放,对修改关闭,即在设计模块时使该模块在不被修改前提下被扩展,通俗点说是可以在不必修改原来封装好的代码的情况下扩展功能。提高开发适应...
  • 软件测试应遵循一些基本原则: 1)尽早地,不断地进行软件测试,把软件测试贯穿于开发过程始终; 2)测试实例应由测试输入数据和对输入数据所期望(预测) 程序结果两部分组成; 3)程序员应避免检查自己编制...
  • 务实型水平设计 我的实用型关卡设计代码和材料。 实用型关卡设计是一本... 最佳实践是什么,类型如何影响应用程序的设计和体系结构,处理类型级别代码的意外复杂性时应遵循的原则。 本书是我第一本书《的直接延续。
  • 《clean code》中搭建系统或重构系统过程中应遵循原则,遵循这些原则可以使整个系统结构更加清晰,便于后期维护和交接。同时,遵循这些原则的前提下可以保证系统在不影响系统功能前提下对系统进行重构。 欢迎...
  • 设计模式-原则

    2021-02-05 13:57:57
    通常情况下,应遵循。只有逻辑够简单,才可在代码级别(通过if…else…)违反;只有类方法数量足够少,才可在方法级别(定义不同方法实现不同操作)保持单一职责 二、接口隔离 客户端不应依赖不需要接口,即对一个类...
  • 软件设计原则

    千次阅读 2018-08-23 21:57:40
    (1)、可重用性:遵循DRY(Don't repeat yourself)原则,减少软件中重复代码。 (2)、可拓展性:当软件需要升级增加新功能,能够在现有系统架构上方便创建新模块,而不需要更改软件现有结构,也不会...
  • 我们先要写出低耦合高内聚的代码,在java中需要遵循如下原则: 模块间依赖通过抽象类或接口发生,实现类之间依赖关系也是通过抽象类或接口产生(实现类之间不发生直接依赖关系),降低系统耦合性 接口或...
  • 即软件实体尽量在不修改原有代码的情况下进行扩展。为了满足开闭原则,需要对系统进行抽象化设计,抽象化是开闭原则的关键。 开放-封闭原则是面向对象设计的核心所在。遵循这个原则可以带来面向对象技术所声称...
  • 熟练掌握和应用面向对象设计(Object Oriented Design,OOD)7大原则,是初/中级JAVA工程师向高级/资深工程师进阶一个必备技能,它可以大大提升程序...开闭原则是在设计一个对象(类、模块、函数)时,应遵循或做
  • 一、介绍 1、在面向对象编程领域中,...遵循这种原则的代码在扩展时并不发生改变,因此无需上述过程。 2、开闭原则(Open Close Principle)是编程中最基础,最重要的设计原则。 3、一个软件实体如类、模块和函数
  • 这个设计原则,其实是说用户在设计系统的时候应遵循的标准和规范。阅读前我一直以为写的是作者在设计 Erlang/OTP 框架时的一些原则。 闲话少叙。Let's go! 1.概述 OTP设计原则规定了如何...
  • 函数单一职责原则(SRP)

    千次阅读 2012-08-06 23:08:51
    在面向对象设计,我们都知道要遵循单一职责原则(SRP),而函数也应遵循这一原则,以保证函数体逻辑清晰并且高内聚。   以下示例中,UpdateValue函数与下面m_value赋值语句造成了逻辑分散: 当需要变更m...
  • Spring中的设计模式

    千次阅读 2018-12-21 18:12:58
    而这23个设计模式中都或多或少的遵循了这6个设计原则。 单一职责原则:类功能要单一,不能写大而全类。 单一接口原则:接口功能尽可能少。 开闭原则:对修改关闭,对扩展开放:框架和代码应该对修改是关闭...
  • 面向对象原则--开闭原则

    千次阅读 2016-08-09 14:53:41
    开闭原则(OCP)是面向对象设计中“可复用设计”的基石,是面向对象设计中最重要的原则之一,其它很多的设计原则都是实现开闭原则的一种手段。开闭原则(Open-Closed Principle, OCP):一个软件实体应当对扩展开放,...
  • T6-《信息系统开发与管理》---系统设计 一,【前言】 在了解系统设计之前,我们还是通过几个非常基本,简单的问题来去了解一下: (1)... (4)系统设计中代码设计的原则是什么? 系统设计思维导图如下: 二,【详情】 
  • 遵循的最重要的原则是 分离关注点,也就是解藕,遵循单一职责原则。一种常见的错误是在一个 Activity 或 Fragment 中编写所有代码。这些基于界面的类仅包含处理界面和操作系统互动的逻辑。...
  • P2:开闭原则(OCP)

    2019-11-27 11:18:48
    开闭原则Open-Closed Principle,简称OCP,是面向对象可复用设计中最重要的设计原则,具体定义如下:一个系统应当对扩展开放,对修改关闭,即软件系统在不修改原有功能代码的情况下进行扩展(非必要时不轻易修改...
  • 开闭原则(OCP):类,模块,函数应该对修改关闭,对扩展开放,java的代码应遵循开闭原则 一个抽象类:定义模板方法,定义了一套执行逻辑顺序 几个抽象类实现 如果煮饮品过程是这样: public class ...

空空如也

空空如也

1 2 3 4
收藏数 79
精华内容 31
关键字:

代码设计应遵循的原则