代码开发规范

合集下载

代码开发规范

代码开发规范

代码开发规范代码开发规范是指开发团队在进行代码编写和维护时遵循的一系列规则和标准。

良好的代码规范可以提高代码的可读性、可维护性和可扩展性,减少代码的错误和缺陷。

1. 命名规范:- 使用有意义的命名:变量、函数、类和文件命名应具有相关性,能够清楚地表达其含义。

- 遵循命名约定:使用一致的命名约定,如驼峰命名法或下划线命名法。

- 避免使用过长或过短的命名。

- 避免使用拼音或缩写命名。

2. 注释规范:- 提供详细和清晰的注释:注释应解释代码的意图、实现细节和特殊考虑。

- 避免无用的注释。

- 注释应该与代码保持同步,保持更新。

3. 代码结构:- 使用适当的缩进和空格来提高代码的可读性。

- 使用合适的格式化和对齐规则。

- 函数和类的定义应该遵循良好的结构和概念标准。

- 避免冗余的代码块和重复的代码。

4. 错误处理:- 在代码中处理异常情况,避免出现未处理的异常。

- 使用适当的错误处理机制,如异常处理或错误返回值。

- 避免使用空的catch块。

5. 单元测试:- 编写单元测试来验证代码的正确性。

- 单元测试应该有清晰的测试目的,覆盖尽可能多的代码路径。

- 单元测试应该能够独立运行,不依赖于外部环境或其他测试。

6. 版本控制:- 使用版本控制工具来管理代码的版本和变更历史。

- 遵循版本控制的最佳实践,如频繁提交、合理分支管理等。

- 避免在版本控制中存储二进制文件。

7. 安全性:- 在代码中防止常见的安全漏洞,如SQL注入、跨站脚本攻击等。

- 避免使用硬编码的密码和敏感信息。

- 使用安全的身份验证和授权机制。

8. 性能优化:- 减少不必要的计算和内存消耗。

- 使用高效的算法和数据结构。

- 避免频繁的IO操作。

- 使用缓存和异步操作来提高性能。

9. 文档:- 提供清晰和详尽的文档,包括代码注释、README文件和用户指南。

- 文档应该包含代码的使用方法、配置说明和常见问题解答等。

10. 持续集成:- 使用持续集成工具来自动构建、测试和部署代码。

软件开发的代码规范

软件开发的代码规范

软件开发的代码规范软件开发是一项复杂的工程,需要多个程序员一起完成。

在开发过程中,遵循一定的代码规范可以提高团队的开发效率,降低维护成本,保证代码的可读性和可维护性。

本文主要介绍软件开发中的代码规范。

一、代码的命名规范1. 类名和接口名应该使用 UpperCamelCase 的命名方式,即每个单词的首字母大写,不要包含下划线。

2. 变量名和函数名应该使用 lowerCamelCase 的命名方式,即第一个单词小写,后面的单词首字母大写,也不要包含下划线。

3. 常量名应该使用大写字母和下划线的命名方式,例如MAX_LENGTH。

4. 参数名应该使用 lowerCamelCase 的命名方式,除非已有一个约定俗成的命名方式,例如 event。

二、代码的缩进和换行1. 如果使用空格作为缩进,应该使用两个空格作为一个缩进层级。

2. 每行代码的长度应该在 80 个字符以内,如果超过了应该换行,并把下一行缩进到当前层级的两个空格之后。

3. 在任何情况下,都不应该在一行代码中写太多逻辑,应该尽量分解成多个小的逻辑块,以提高代码的可读性。

三、代码的注释规范1. 在代码的头部应该包含文件名、作者、日期和版本等信息,方便其他开发者了解代码的相关信息。

2. 在代码中应该加入适量的注释,解释代码的含义和实现过程,以方便其他开发者理解代码。

3. 不应该在代码中使用无用的注释,例如重复了代码本身,或者解释了显而易见的逻辑。

四、代码的格式化规范1. if、for、while、do 等关键字后面应该有空格,例如 if (a ==b)。

2. if、for、while、do 等关键字的语句块应该用花括号括起来,即使只有一条语句。

3. 对于函数的参数列表,应该尽量每行一个参数,以便于代码可读性。

4. 不要在一行代码中写多个语句,即使使用分号隔开。

五、代码的质量规范1. 代码应该尽量避免冗余和重复的内容,尽量复用已有的代码。

2. 代码应该尽量遵循单一职责原则,即每一个函数和类只做一件事情。

软件工程的代码规范(一)2024

软件工程的代码规范(一)2024

软件工程的代码规范(一)引言概述:软件工程的代码规范是一种约定俗成的指南,旨在帮助开发团队编写一致、易于维护和理解的高质量代码。

本文将介绍软件工程中代码规范的重要性及其对软件开发流程的影响,并详细说明五个方面的代码规范内容。

正文:一、命名规范1. 使用有意义且描述性的变量、函数和类名,避免使用无意义的缩写或简写。

2. 使用驼峰命名法或下划线命名法来命名变量和函数。

3. 为类名使用大写字母开头的驼峰命名法。

二、代码风格规范1. 使用一致的缩进风格,例如使用两个空格或四个空格作为缩进。

2. 使用适当的空格和换行符来增加代码的可读性,例如为操作符和关键字周围添加空格。

3. 在注释中使用清晰的语言描述代码的功能和目的。

三、函数和方法规范1. 函数和方法应该短小精悍,只做一件事情,并遵循单一职责原则。

2. 为函数和方法添加清晰的注释,描述其输入、输出和功能限制。

3. 合理使用异常处理机制,减少代码中的错误处理代码。

四、代码复用规范1. 避免编写重复的、冗余的代码,提倡代码的复用性。

2. 将相似的功能抽象为可复用的函数或类,减少代码量和维护成本。

3. 鉴别合适的时机将代码封装,以便在其他项目中使用。

五、注释规范1. 在代码中添加适当的注释来解释复杂的逻辑和算法。

2. 为公共接口和重要函数添加文档注释,描述其使用方法和注意事项。

3. 删除无用的注释代码,保持代码的简洁性。

总结:软件工程的代码规范是提高代码质量和团队协作效率的重要手段。

良好的代码规范可以增加代码的可读性、可维护性和可扩展性,减少错误和重复代码的出现。

通过遵循命名规范、代码风格规范、函数和方法规范、代码复用规范以及注释规范,开发团队可以创建出更加优秀的软件工程项目。

软件开发中的代码规范

软件开发中的代码规范

软件开发中的代码规范在软件开发过程中,代码规范是一个非常重要的方面。

它可以增强代码的可读性和可维护性,提高团队合作和代码质量。

代码规范涵盖了代码布局、命名规则、注释风格、函数编写等多个方面。

本文将探讨软件开发中的代码规范,并列举一些常用的规范实践。

一、代码布局良好的代码布局可以使代码更易于阅读和理解。

以下是一些常用的代码布局规范:1. 缩进:使用4个空格进行缩进,而不是制表符。

这样可以保持不同编辑器之间的一致性。

2. 换行:每行代码的长度应适中,一般不超过80个字符。

如果一行代码过长,可以使用换行符将其拆分为多行。

同时,运算符应该位于换行符之前。

3. 空行:在不同的代码块之间、函数之间和逻辑段落之间添加适当的空行,以提高可读性。

4. 对齐:在声明变量、定义函数等情况下,保持对齐的代码布局可以使代码更加整洁和易读。

二、命名规范命名规范可以使代码的含义更加清晰,并且便于其他开发人员理解和维护。

以下是一些常用的命名规范实践:1. 变量和函数名:使用有意义的命名,避免使用缩写和单个字符命名。

命名应使用小驼峰命名法,即首字母小写,后续每个单词的首字母大写。

2. 常量名:常量应使用全大写字母,并使用下划线分隔单词。

3. 类名:类名应使用大驼峰命名法,即首字母大写,后续每个单词的首字母大写。

4. 文件名:文件名应使用有意义的命名,避免使用特殊字符和空格。

文件名应与文件中定义的类或功能相匹配。

三、注释风格良好的注释风格可以增加代码的可读性和可维护性,方便其他开发人员了解代码的用途和实现逻辑。

以下是一些常用的注释规范实践:1. 文件注释:每个代码文件的开头应包含文件注释,描述文件的用途、作者和日期信息。

2. 函数注释:每个函数的开头应包含函数注释,描述函数的功能、输入参数、返回值和异常情况。

3. 行内注释:在复杂的代码段或关键逻辑处添加适当的行内注释,解释代码的用途和实现方式。

4. 注释更新:当代码发生变动时,应及时更新相关的注释,保持注释与代码的一致性。

代码开发规范

代码开发规范

代码开发规范1 前言1.1 为什么需要开发规范编码规范对于程序员而言尤为重要,有以下几个原因:* 一个软件的生命周期中,80%的花费在于维护* 几乎没有任何一个软件,在其整个生命周期中,均由最初的开发人员来维护 * 编码规范可以改善软件的可读性,可以让程序员尽快而彻底地理解新的代码* 如果你将源码作为产品发布,就需要确任它是否被很好的打包并且清晰无误,一如你已构建的其它任何产品1.2 开发规范的作用* 减少维护花费* 提高可读性* 加快工作交接* 减少名字增生* 降低缺陷引入的机会2 命名规范2.1 常量命名规范2.1.1 类型常量命名规范2.1.2 说明常量用于保存需要常驻内存中并且经常使用变化不多的数据,定义常量的名称的时候需要遵循望文知意的原则;2.1.3 规则1.全部为大写字母;2.中间以“_”连接;3.望文知意原则;2.1.4 备注代码中涉及到直接使用某个字符串或者其他基本类型的值时,建议定义成常量,避免多处直接使用同样的值作为参数。

2.1.5 举例• 如:定义一个常量表示最小屏幕宽度的常量,则可以定义一个int类型的常量,该常量可以命名为:“MIN_SCREEN_WIDTH“;• 其他举例:• 例如:static final int MIN_SCREEN_WIDTH = 4;( √)(×)• 例如:static final int min_screen_width = 4;(×)• 例如:static final int minScreenWidth = 4;• 例如:static final int WIDTH = 4;(×);(×)• 例如:static final int width = 4;(×)• 例如:static final int wd = 42.2 变量命名规范2.2.1 类型变量命名规范2.2.2 说明变量用于保存系统中的临时数据,变量命名时遵循望文知意,简单明了,驼峰标示等原则。

编程技术中的代码规范与开发规范

编程技术中的代码规范与开发规范

编程技术中的代码规范与开发规范在当今的软件开发领域,代码规范与开发规范是非常重要的。

它们不仅能够提高代码的可读性和可维护性,还能够提高团队协作效率,减少错误和bug的出现。

本文将探讨编程技术中的代码规范与开发规范,并介绍一些常见的规范原则和实践。

一、命名规范命名规范是代码规范中最基础也是最重要的一部分。

良好的命名规范能够使代码更易读、易懂。

在命名变量、函数、类等元素时,应该遵循以下原则:1. 变量名和函数名应该具有描述性,能够清晰地表达其用途和含义。

避免使用简单的单词或缩写,而应该使用具有明确含义的单词或短语。

2. 使用驼峰命名法或下划线命名法来命名变量和函数。

驼峰命名法将多个单词连接在一起,每个单词的首字母大写,例如:myVariableName;下划线命名法使用下划线将多个单词连接在一起,例如:my_variable_name。

3. 类名应该以大写字母开头,并使用驼峰命名法。

类名应该能够清晰地表达其所代表的对象或概念。

二、缩进与空格良好的缩进和空格使用可以使代码更易读、易懂。

在编写代码时,应该遵循以下原则:1. 使用适当的缩进来表示代码块的层次结构。

通常情况下,使用四个空格或一个制表符来进行缩进。

2. 在运算符前后、逗号后、分号后等地方留出适当的空格。

这样可以提高代码的可读性,使代码更加清晰。

三、注释注释是代码规范中非常重要的一部分。

良好的注释可以帮助他人理解代码的用途和实现方式。

在编写代码时,应该遵循以下原则:1. 在关键的代码段前添加注释,解释代码的用途和实现思路。

这样可以帮助他人更好地理解代码,并且在以后的维护工作中提供参考。

2. 在函数或方法的头部添加注释,解释函数或方法的功能、输入参数、输出结果等信息。

这样可以使他人更容易使用和理解这些函数或方法。

四、错误处理与异常处理良好的错误处理和异常处理是编程中非常重要的一部分。

在编写代码时,应该遵循以下原则:1. 在可能出现错误的地方进行错误处理。

软件开发中的代码规范

软件开发中的代码规范

软件开发中的代码规范在一份代码中,要想尽可能地简单易懂,就需要遵守一套代码规范。

代码规范可以保证代码的质量,防止出现不必要的错误,以及提高代码的可维护性。

软件开发中的代码规范也是同样重要的。

下面将从命名规则、缩进、注释代码规范等多个方面来谈论软件开发中的代码规范。

一、命名规则在程序中,定义变量,函数,常量时名称的规则是一样的,都要尊重以下名称约定:1、命名不得使用单个字母,除非是临时变量。

2、命名应该简明扼要、易于理解,应取上下文相关的名称。

3、类名与接口名称必须采用驼峰式命名法,即单词的首字母大写,这样更加直观和方便。

4、变量、函数、常量等的名称采用小写字母,单词之间用下划线分割,例如:max_goodbye_num。

二、缩进规范缩进是为了使代码排版清晰、结构清晰,方便阅读和维护。

在软件开发中可以遵循以下规则:1、缩进的空格数为4个,而不是2个,可以根据自己的习惯来设置,但在团队中最好保持统一,以避免不同的编码规则带来的问题。

2、左括号“{”要放在同一行,而不是独立的一行。

3、代码中不要出现过多的空格,容易让程序变得混乱和难以阅读,也不要出现过多的空行,这样会浪费空间。

三、注释规范代码注释是提高代码可读性和可维护性的重要方式。

在软件开发中,注释应该注意以下几点:1、注释应该清晰明了、精炼简洁,并且准确描述代码的功能,对代码进行适当解释和说明;2、应尽可能地避免翻译内容,注意语言表达的准确性和规范性;3、注释之间的空格和代码行有一定的距离,以使代码更加易于阅读;4、注释中避免使用缩写和不规范的缩写。

四、其他规范1、在代码中不能出现中文字符,英文一定要标准。

2、尽量少使用全局变量等危险机制,以避免因误操作而导致不必要的麻烦。

3、使用try-catch的代码必须清晰明了,不能使用空语句或者只有单行的if语句等,要带有较为详细的解释。

通过以上几点代码规范,我们可以更好地控制代码质量,提高代码可维护性。

软件开发公司代码编写规范

软件开发公司代码编写规范

软件开发公司代码编写规范软件开发公司的代码编写规范是为了确保开发出高质量、可维护、可扩展的软件。

本文将介绍一些常见的代码编写规范,旨在提高团队协作效率和代码质量,并促进项目的成功开发。

1. 命名规范- 使用有意义、清晰简洁的变量、函数和类名称。

- 遵循驼峰命名法,首字母小写。

- 类名应以大写字母开头。

- 避免使用缩写和简写,尽量使用具有描述性的名称。

2. 注释规范- 对代码进行详细注释,解释代码的功能、目的和实现方式。

- 注释应放在代码行上方,使用自然语言、规范的语法。

- 避免过多无用的注释,注释应精准、简洁明了。

3. 编码规范- 使用一致的缩进和空格,增强代码的可读性。

- 适当添加空行将代码分块,提高代码的可读性。

- 代码行长度控制在80个字符以内,避免过长的代码行。

- 使用简洁明了的语句和表达式,避免过度复杂的代码逻辑。

4. 错误处理规范- 使用异常处理机制处理可能出现的异常情况。

- 避免使用裸露的try-catch语句块,应具体指明捕获的异常类型。

- 在异常处理中提供清晰的错误提示信息。

5. 面向对象规范- 使用设计模式和面向对象的原则,提高代码的可维护性和扩展性。

- 单一职责原则:每个类应该只有一个明确的责任。

- 开放封闭原则:对扩展开放,对修改封闭。

6. 文档规范- 编写清晰的文档,介绍项目的整体结构、功能和使用方法。

- 说明代码中特殊函数、算法或者复杂业务逻辑的实现方式。

- 提供示例代码和演示,帮助他人更好地理解和使用代码。

7. 版本控制规范- 使用版本控制工具(如Git)进行代码管理,并遵守团队约定的分支规范。

- 提交代码前进行代码审查,确保代码质量和规范。

- 使用有意义的提交信息,描述代码变更内容。

8. 测试规范- 使用单元测试框架编写单元测试用例,覆盖核心逻辑。

- 遵循测试驱动开发(TDD)原则,在编写代码前先编写测试用例。

- 运行自动化测试,确保代码变更不会破坏系统稳定性。

总结:软件开发公司的代码编写规范是确保团队成员以相同的标准进行代码编写,提高代码质量和可维护性的重要规范。

  1. 1、下载文档前请自行甄别文档内容的完整性,平台不提供额外的编辑、内容补充、找答案等附加服务。
  2. 2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
  3. 3、如文档侵犯您的权益,请联系客服反馈,我们会尽快为您处理(人工客服工作时间:9:00-18:30)。

代码开发规范1 前言1.1 为什么需要开发规范编码规范对于程序员而言尤为重要,有以下几个原因:* 一个软件的生命周期中,80%的花费在于维护* 几乎没有任何一个软件,在其整个生命周期中,均由最初的开发人员来维护* 编码规范可以改善软件的可读性,可以让程序员尽快而彻底地理解新的代码* 如果你将源码作为产品发布,就需要确任它是否被很好的打包并且清晰无误,一如你已构建的其它任何产品1.2 开发规范的作用* 减少维护花费* 提高可读性* 加快工作交接* 减少名字增生* 降低缺陷引入的机会2 命名规范2.1 常量命名规范2.1.1 类型常量命名规范2.1.2 说明常量用于保存需要常驻内存中并且经常使用变化不多的数据,定义常量的名称的时候需要遵循望文知意的原则;2.1.3 规则1.全部为大写字母;2.中间以“_”连接;3.望文知意原则;2.1.4 备注代码中涉及到直接使用某个字符串或者其他基本类型的值时,建议定义成常量,避免多处直接使用同样的值作为参数。

2.1.5 举例•如:定义一个常量表示最小屏幕宽度的常量,则可以定义一个int类型的常量,该常量可以命名为:“MIN_SCREEN_WIDTH“;•其他举例:•例如:static final int MIN_SCREEN_WIDTH = 4;( √)•例如:static final int min_screen_width = 4;(×)•例如:static final int minScreenWidth = 4; (×)•例如:static final int WIDTH = 4;(×)•例如:static final int width = 4;(×)•例如:static final int wd = 4;(×)2.2 变量命名规范2.2.1 类型变量命名规范2.2.2 说明变量用于保存系统中的临时数据,变量命名时遵循望文知意,简单明了,驼峰标示等原则。

2.2.3 规则1.首字母小写;2.java驼峰命名;3.望文知意原则;4.推荐引用类型变量添加前缀“m”;5.如果是View组件变量,则组件名称为xml文件中定义的ID名称去掉下划线,下划线后一位大写;2.2.4 备注无2.2.5 举例•如:定义一个表示最小屏幕宽度的变量,则可以定义一个int型的临时变量为:mMinScreenWidth;•例如:static final int mMinScreenWidth = 4;( √)•例如:static final int minWidth = 4;(×)•例如:static final int screenWidth = 4;(×)•例如:static final int width = 4;(×)•例如:static final int min = 4;(×)•例如:static final int msw = 4;(×)2.3 方法命名规范2.3.1 类型方法命名规范2.3.2 说明方法名的命名应该遵循简单明了的原则;2.3.3 规则1.首字母小写;2.java驼峰命名;3.简单明了原则;4.初始化View方法init*(每个init做一件事)2.3.4 备注•同时在方法的实现上,尽量不要在一个方法中出现太多实现代码,如一个方法有几百行的实现逻辑,推荐在逻辑复杂时,按功能点拆分出多个方法,便于阅读。

•另外,出现功能一样的实现逻辑,尽量抽取公用方法,避免将实现逻辑复制到多个用到的地方。

2.3.5 举例•如:定义一个获取屏幕宽度的方法,依照上述原则,则可以定义为一个静态方法:public static int getScreenWidth();•例如:public static int getScreenWidth();( √)•例如:public static int getscreenwidth();(×)•例如:public static int getScreenwidth();(×)•例如:public static int getWidth();(×)•例如:public static int getScreen();(×)•例如:public static int getSW();(×)2.4 类命名规范2.4.1 类型类命名规范2.4.2 说明类名主要表示一个类的作用,需要简明扼要,望文知意,并且首字母大写。

2.4.3 规则1.首字母大写;2.java驼峰命名;3.望文知意原则;4.能够说明类的功能和主要作用(注释的作用);5.Acitivity类以Acitivity结尾;6.Fragment类以Fragment结尾;7.Service类以Service结尾;8.BroadcastReceiver类以Receiver结尾;9.ContentProvider类以Provider结尾;10.Application类以Application结尾;11.自定义View类以Custom**View结尾;12.自定义Adapter类以Adapter结尾;13.adapter中的ViewHolder以Holder结尾;14.实体Bean以Model结尾;2.4.4 备注无2.4.5 举例•如:定义一个获取屏幕信息的工具类,则可以定义为public class ScreenUtils;•例如:public class ScreenUtils; ( √)•例如:public class Screenutils; (×)•例如:public class Screen; (×)•例如:public class screenutils; (×)•例如:public class screen; (×)•例如:public class su;(x)2.5 接口命名规范2.5.1 类型接口命名规范2.5.2 说明接口命名需要简单明了,长度不宜过长;2.5.3 规则1.首字母大写(第二个字母也是大写);2.java驼峰命名;3.望文知意原则;4.建议在名称前面追加“I”;2.5.4 备注•I**Listener•I**CallBack•I**;2.5.5 举例•如:定义一个activity的方法接口,实现接口中的某些方法:public interface IFunctionListener;•例如:public interface IFunctionListener;( √)•例如:public interface BaseActivity; (×)•例如:public interface Baseactivityinter; (×)•例如:public interface BaseInter; (×)•例如:public interface ActivityInter;(×)2.6 包名规范2.6.1 类型包名规范2.6.2 说明用于分类管理类文件;2.6.3 规则1.所有字母小写;2.简单明了,层级很深,没有拼接的包名;3.望文知意;4.按功能划分包名,如“我的”5.工具类可以划分为一个工具类的包名,utils,里面可以添加包名层级;6.系统类的可以划分为一个系统类的包,system,里面可以添加包名层级;7.组件类的可以划分为一个组件类的包,*,里面添加adapter的包名,自定义view包名;8.Service类的可以划分为一个服务类的包,service,里面可以添加包名层级;9.数据库相关类可以划分为一个数据库类,db,里面可以添加数据库相关类,Bean类,数据库服务类等;10.广播类的可以划分为广播类的包,receiver,可以放一些广播相关的类;11.网络类相关的可以划分为,network,放一些网络相关的类;12.Fragment类存放在fragment包下;13.Activity类存放在Activity包下;2.6.4 备注无2.6.5 举例无2.7 目录名称规范2.7.1 类型目录名称规范2.7.2 说明主要是一些jar包,so文件的配置目录名称;2.7.3 规则1.全部为小写字母;2.简单明了;3.望文知意;4.驼峰表示;2.7.4 备注无2.7.5 举例•后期增加目录的可能性不多,现列举出系统中存在的目录结构:•lib:第三方jar的保存路径;•jniLibs:jni引用的so文件的目录;2.8 布局文件名称规范2.8.1 类型布局文件名称规范2.8.2 说明主要包含资源文件的命名问题;2.8.3 规则1.全部为小写字母;2.中间以”_”连接;3.望文知意原则;4.布局文件的开头问类名;5.列表项的xml布局文件名称:类名_item.xml;6.activity类的xml文件名称:类名_activity.xml;7.fragment类的xml文件名称:类名_fragment.xml;8.自定义View的xml文件的名称:类名_父类名.xml;2.8.4 备注无2.8.5 举例如:如定义H5Activity的xml文件名称,则可以定义为h5.xml;尽量不使用大写字母等。

2.9 drawable文件名称规范2.9.1 类型drawable文件名称命名规范2.9.2 说明主要包含资源文件的命名问题;2.9.3 规则1.全部为小写字母;2.中间以”_”连接;3.望文知意原则;4.布局文件的开头问类名;5.11_22_33_44,44:selector,shape(大概五六个,暂时不定义其他的);33:src、bg、color(可扩展,可为空);22:状态名称或者为空;11:业务名称2.9.4 备注无2.9.5 举例无2.10 资源ID规范2.10.1 类型资源ID命名规范2.10.2 说明各种资源ID的定义问题;2.10.3 规则1.全部为小写字母;2.中间以”_”连接;3.望文知意原则;2.10.4 备注可以考虑按照组件的名称的缩写作为前缀,(同一个xml文件中ID名称不能重复)如:组件简写(大写字母缩写)_业务名称TextView的组件:tv_pay_moneyButton的组件:btn_pay_moneyEditText的组件:et_user_nameLinerLayout组件:ll_container2.10.5 举例如:比如一个textview组件,可点击用于支付的按钮,则可以把ID定义为:tv_pay_money;3 注释规范3.1 类注释在类、接口定义之前当对其进行注释,包括类、接口的目的、作用、功能、继承于何种父类,实现的接口、实现的算法、使用方法、示例程序等。

相关文档
最新文档