新手写代码的要点

原文链接: http://tieba.baidu.com/p/5057895435?pn=1

优秀的代码基本遵循这四个特性:可维护性、可扩展性、可读性和可移植性。

1.代码格式,驼峰标识,缩进,命名规范:

建议使用一致的代码格式,采用驼峰命名法,统一的缩进风格,并遵循良好的命名规范,以提高代码的可读性。

2.写代码时请先想后写,不要边想边写:

强调在写代码之前先进行思考,明确功能需要使用哪些类,类与类之间的关系是什么,确保在开始编写代码之前有清晰的设计思路。

3.一个类里请不要写太多方法(实体类除外):

提倡单一职责原则,一个类应该有一个单一的责任。在类中限制方法数量,保持高内聚性,提高代码的可维护性和可读性。

4.一个方法里不要写太多代码:

强调方法的简洁性和可维护性,一个方法应该专注于完成一个特定的任务,不要将过多的逻辑堆积在一个方法中。

5.当一段代码被你复制到多个地方使用时,请封装这段代码:

提倡遵循“不重复原则”,当一段代码需要在多个地方使用时,将其封装成一个方法或类,以便在多处调用。

6.继承可以帮你节约很多代码,但请尽量少用继承:

警示过度使用继承可能引发的问题,提倡多用组合而不是继承,以避免继承带来的复杂性和脆弱性。

7.组合和继承相反,是一种松散的结构,因此用组合来代替继承是一种很好的设计:

强调使用组合来构建松散耦合的结构,以提高系统的灵活性和可维护性。

8.思考一个功能时不要考虑先干什么后干什么,正确的思考方式是:

强调功能设计时应该首先考虑需要使用哪些类,类与类之间的关系是什么,而不是着眼于具体的实现细节。

9.将接口作为入参是一种很好的设计方式,请在你的代码中尝试使用它:

提倡使用接口来定义入参,以提高代码的可扩展性和灵活性。

10.接口职责请尽量单一,5个接口协同完成一个功能要远远超过一个接口完成5个功能:

提倡接口的单一职责原则,一个接口应该只有一个理由发生变化,以降低系统的耦合度。

11.如果你用一个字符串作为标识,请尝试把它设计成数据字典或配置文件:

建议使用数据字典或配置文件来管理字符串标识,提高代码的可维护性和可配置性。

11.如果你实在懒得写数据字典或配置文件请至少把它写成枚举:

即使不使用数据字典或配置文件,也建议将字符串标识定义为枚举,以提高代码的可读性和维护性。

11.如果你实在懒得写枚举,请至少把它写成常量:

即使不使用枚举,也应该将字符串标识定义为常量,以提高代码的可维护性和防止魔法数字。

11.软件设计中有很多原则,大部分你可以不记,但请务必记住其中的一个“开闭原则”:

强调开闭原则,即软件实体应该对扩展开放,对修改关闭。设计时应该使系统具有良好的扩展性,而不是频繁修改已有代码。

"开闭原则"是面向对象设计中的一个重要原则,它指导着软件实体(类、模块、函数等)应该对扩展开放,而对修改关闭。这意味着在不修改现有代码的情况下,能够通过扩展来添加新的功能。

具体而言,当系统需要进行变更时,应该通过增加新代码而不是修改已有代码来实现。这有助于降低对现有代码的影响,减少引入新问题的风险,同时提高系统的可维护性和可扩展性。

以下是一个简单的例子来说明开闭原则:

假设有一个图形绘制系统,最初只能绘制矩形:

class Rectangle {
    void draw() {
        // 绘制矩形的具体逻辑
        System.out.println("Drawing a rectangle");
    }
}

现在,如果需要添加对圆形的绘制支持而不修改 Rectangle 类,我们可以通过创建新的图形类 Circle 来实现:

class Circle {
    void draw() {
        // 绘制圆形的具体逻辑
        System.out.println("Drawing a circle");
    }
}

通过扩展而非修改现有代码,符合开闭原则。客户端代码可以使用这两个类来绘制矩形和圆形,而不需要改动原有的 Rectangle 类。这种设计使得系统更容易扩展,同时不会破坏已有的功能。

总的来说,开闭原则的目标是使系统更加灵活,能够适应变化,同时保持稳定性。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 202,980评论 5 476
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,178评论 2 380
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 149,868评论 0 336
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,498评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,492评论 5 364
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,521评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,910评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,569评论 0 256
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,793评论 1 296
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,559评论 2 319
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,639评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,342评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,931评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,904评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,144评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,833评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,350评论 2 342

推荐阅读更多精彩内容