代码规范总结

前言       

       作为一名优秀的程序媛,最基本的代码规范那是万万不可小觑的,它体现了我们的职业操守和职业修养。

重要性

1.一个软件的生命周期中,80%的花费在于维护,代码规范降低了金钱成本和时间成本。

2.几乎没有任何一个软件,在其整个生命周期中,均由最初的开发人员来维护,代码规

范减少了工作交接过程中的交流成本。

3.规范可以改善软件的可读性,可以让程序员尽快而彻底地理解新的设计和代码,节约

了时间,提高了工作效率。

4.良好的编码规范可以有效避免一些低级错误,赢得同事的夸奖和上司的认可。

命名规范原则

  • 名字应该能够标识事物的特性,并且与业务挂钩。
  • 名字一律使用英文单词,而不能为拼音。
  • 名字可以有两个或三个单词组成,但不应多于4个,控制在3至30个字母以内。
  • 在名字中,多个单词用大写第一个字母(其它字母小写)来分隔。例如:IsSuperUser。
  • 命名避免和以下关键字冲突如:Base,Date,Class……
  • 方法名、参数名统一使用驼峰命名法(Camel命名法),除首字母外,其他单词的首字母大写,其他字母小写,类名每个组合的单词都要大写;正例:localValue、getHttpMessage、inputUserId

注释规范原则

  •  一般情况下,源程序的有效注释量必须在30%以上。
  • 避免使用装饰性内容,保持注释的简洁。
  • 注释信息不仅要包括代码的功能,还应给出原因,不要为注释而注释。

单行注释:

//……

 块注释:

/*……*/

文档注释:

/**……*/

感谢阅读~

  • 1
    点赞
  • 1
    收藏
    觉得还不错? 一键收藏
  • 13
    评论
在面向对象的编程中,设计模式是一种旨在解决常见问题的最佳实践方法。设计模式可以提供可重用的代码,提高代码的可靠性,并使代码更易于理解和维护。要学习设计模式,你可以从以下几个步骤开始: 1. 了解设计模式的分类:设计模式可以分为三类:创建型模式,结构型模式和行为型模式。每个类别都包含了一些常见的设计模式,比如单例模式,适配器模式,观察者模式等。 2. 了解每个设计模式的特点和适用场景:每个设计模式都有自己的用途和适用场景。通过深入了解每个模式的特点和使用方法,你可以更好地选择适合你的问题的设计模式。 3. 学习设计模式的实现方式:设计模式可以用不同的编程语言来实现。你可以选择一种你熟悉或感兴趣的编程语言,然后通过阅读相关文档、书籍或参考代码来学习如何实现设计模式。 4. 实践应用设计模式:理论知识只是一部分,实践是学习设计模式的关键。尝试在自己的项目中应用设计模式,通过解决实际问题来巩固你对设计模式的理解和应用能力。 当涉及到代码规范设计模式时,要考虑以下几个方面: 1. 命名规范:为了清晰和易于理解,命名设计模式的类、方法和变量时应该遵循代码规范。 2. 结构和组织:设计模式的结构必须符合良好的代码组织原则,并且要保持一致性和可读性。 3. 注释和文档:为了帮助他人理解你的代码,你应该提供详细的注释和文档,解释你使用的设计模式以及它们的目的和用法。 总结起来,在代码规范设计模式时,你应该遵循良好的命名规范,结构和组织你的代码,并提供适当的注释和文档,以确保代码的可读性和可维护性。

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 13
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值