`
nesta13
  • 浏览: 116263 次
  • 性别: Icon_minigender_1
  • 来自: 广州
社区版块
存档分类
最新评论

编程风格和文档记录要求

阅读更多

编程风格

1、广泛使用方法

2、使用似有数据字段

3、错误处理

4、可读性

5、文档记录

 

 

文档记录要求

 

1、程序的初始注释

a、作用描述

b、作者和日期

c、程序输入和输出的描述

d、程序用法描述

e、诸如所需数据类型的假设

f、异常描述、换言之,哪些会出错

g、简述主要类

 

2、声明类的作用,并描述类包含的数据(常量或变量)

 

3、声明方法的作用、初始条件、结束条件和调用的方法

 

4、方法体注释,解释重要功能或微妙的逻辑

分享到:
评论

相关推荐

    《Java编程风格》翻译版.pdf

    总结来说,《Java编程风格》翻译版提供的这些编码规范和约定旨在指导Java开发人员编写出更清晰、一致和易于维护的代码。遵循这些规范能够提高代码质量,提升开发效率,以及减少因代码理解偏差而导致的错误。虽然编码...

    编程文档规范

    13. **技术债务文档**:技术债务文档记录了为了快速迭代而做出的妥协,以及未来需要解决的问题。 通过遵循这些编程文档规范,团队可以更有效地沟通、协作,减少误解,提高开发效率,并降低长期维护的成本。每个项目...

    Java编程风格

    在《Java编程风格》翻译版.pdf中,你可以找到针对中文读者的详尽解释,使国内开发者能够更好地理解和应用这些编程原则。这份中文译本确保了语言的通顺和理解的准确性,让国内的Java开发者无需语言障碍就能学习到国际...

    多文档的编程

    这个“用多文档实现的formview记录程序”源代码就是一个很好的学习资源,它展示了如何将CFormView集成到MDI框架中,实现数据的记录和显示。通过分析和运行这个示例,你可以更直观地了解MDI应用的工作原理。

    C#编程风格Word版

    根据提供的文件信息,我们可以深入探讨其中提及的关键C#编程风格和规范知识点。下面将详细解释这些要点,并结合实际编程场景进行说明。 ### C#编程风格和规范 #### 一、重要原则 1. **保持原有风格**:在修改他人...

    华为开发文档编程规范

    华为作为全球领先的电信解决方案供应商,对开发文档编程规范有着严谨的要求。以下将详细阐述这些规范的重要性和主要内容: 1. **命名规范**:在编程过程中,变量、函数、类、模块等的命名应清晰、简洁且具有描述性...

    java编程风格如何修改

    - 不要忽视异常,应提供适当的日志记录和错误处理。 8. **代码结构**: - 保持类和方法的粒度适中,每个类和方法只做一件事。 - 使用适当的访问修饰符,保护类和成员的可见性。 9. **变量声明**: - 尽可能将...

    编程文档手册

    4. 提升项目质量:规范的文档有助于确保代码遵循一致的风格和标准,提高软件质量。 二、文档类型与内容 1. 项目说明书:介绍项目的目标、背景、预期用户和系统需求。 2. 设计文档:详细描述系统的架构、模块划分、...

    Java编程风格指导.pdf

    Java编程风格指导是软件工程中不可或缺的一部分,它旨在提高代码的可读性和可维护性,降低后期修改和扩展的成本。良好的编程风格不仅让个人开发者受益,也在团队协作中发挥重要作用,确保不同成员编写的代码风格统一...

    java编程风格总结

    在Java开发领域中,良好的编程风格对于提高代码的可读性、可维护性和可扩展性至关重要。以下是从一篇关于Java编程风格的文章中提炼的关键知识点。 #### 一、统一编码规范 **原文摘要:** - **统一编码规范**:保持...

    C#编程风格约定

    C#编程风格约定是.NET开发者遵循的一套标准,旨在提高代码的可读性、可维护性和团队协作效率。这些约定涵盖了命名规则、代码结构、注释、异常处理、类型设计等多个方面。以下是这些约定的一些关键点: ### 1. 命名...

    层次风格文档管理系统框架代码

    【标题】:“层次风格文档管理系统框架代码”是一个基于Java编程语言实现的软件系统,它采用层次化的架构设计,旨在提供高效、稳定且易于维护的文档管理解决方案。此框架的核心目标是帮助用户组织、存储和检索各种...

    google编程风格手册

    **Google编程风格手册**是一份由Google内部制定并广泛使用的编程规范文档,旨在提高代码的可读性和一致性,从而提升开发效率和软件质量。该手册主要关注C++语言的编码风格,并涵盖了从文件结构到变量命名等各个方面...

    ACM竞赛良好的编程风格与规范介绍

    以下是一些关于编程风格和规范的关键点: 1. **版权和版本声明**:在每个文件的开头,应该包含版权信息、文件名、标识符、版本号、作者、修改者和完成日期,以及版本历史信息。这是对代码所有权和演化历程的记录。 ...

    Google C++编程风格指南

    《Google C++编程风格指南》是一本非常重要的资源,它为C++开发者提供了一套统一的编码标准和最佳实践,确保代码的可读性、可维护性和团队协作效率。这份指南由Google公司制定,旨在提高其内部项目代码质量,但后来...

    java后端开发规范word文档

    这份"java后端开发规范word文档"包含了多个方面的内容,包括但不限于编程风格、命名规则、异常处理、并发控制、数据库操作、单元测试、日志记录以及代码组织结构等。 1. **编程风格**:编程风格是代码可读性的基础...

    C++编程风格指南(中英文都有,doc)

    C++编程风格指南是程序员们遵循的一套规则和最佳实践,旨在提高代码的可读性、可维护性和一致性。这份指南包含中英文两种版本,对于初学者和有经验的开发者来说都是一份宝贵的学习资源。以下是一些核心的C++编程风格...

Global site tag (gtag.js) - Google Analytics