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

编程风格和文档记录要求

编程CC++C#F#
阅读更多

编程风格

1、广泛使用方法

2、使用似有数据字段

3、错误处理

4、可读性

5、文档记录

 

 

文档记录要求

 

1、程序的初始注释

a、作用描述

b、作者和日期

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

d、程序用法描述

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

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

g、简述主要类

 

2、声明类的作用，并描述类包含的数据（常量或变量）

 

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

 

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

分享到：
| 《MySQL权威指南（第3版）》读书笔记（2 ...
评论
发表评论

您还没有登录,请您登录后再发表评论

相关推荐

    Access+2000中文版高级编程

    2.1.7 本书的编程风格 31 2.2 VBA初步 31 2.2.1 对象基础 31 2.2.2 使用对象浏览器 32 2.3 使用对象编程 34 2.3.1 关键字Public 35 2.3.2 关键字Private 35 2.4 使用属性和方法 35 2.4.1 使用现有的...

    Spring中文帮助文档

    6.4. AOP声明风格的选择 6.4.1. Spring AOP还是完全用AspectJ？ 6.4.2. Spring AOP中使用@AspectJ还是XML？ 6.5. 混合切面类型 6.6. 代理机制 6.6.1. 理解AOP代理 6.7. 以编程方式创建@AspectJ代理 6.8. 在...

    Hibernate+中文文档

    13.4. DML(数据操作语言)风格的操作(DML-style operations) 14. HQL: Hibernate查询语言 14.1. 大小写敏感性问题 14.2. from子句 14.3. 关联(Association)与连接(Join) 14.4. join 语法的形式 14.5. select...

    Python核心编程第二版

    　第11章　函数和函数式编程　 　11.1　什么是函数？　 　11.1.1　函数vs过程　 　11.1.2　返回值与函数类型　 　11.2　调用函数　 　11.2.1　函数操作符　 　11.2.2　关键字参数 　11.2.3　默认参数　 　11.2.4　...

    nim-docstrings:用 Nim 编程语言编写的类似 Python 的文档字符串

    这些文档字符串用于从记录的过程中自动提取内省文档。 这是 Nim 内置双哈希文档注释的替代方法，因为（在撰写本文时）非编译器代码无法从 AST 中的节点中提取文本。 提供的最重要的过程和宏是： docstring proc...

    Hibernate中文详细学习文档

    13.4. DML(数据操作语言)风格的操作(DML-style operations) 14. HQL: Hibernate查询语言 14.1. 大小写敏感性问题 14.2. from子句 14.3. 关联(Association)与连接(Join) 14.4. join 语法的形式 14.5. select...

    Access 2000中文版高级编程(part1)

    2.1.7 本书的编程风格 31 2.2 VBA初步 31 2.2.1 对象基础 31 2.2.2 使用对象浏览器 32 2.3 使用对象编程 34 2.3.1 关键字Public 35 2.3.2 关键字Private 35 2.4 使用属性和方法 35 2.4.1 使用现有的属性 35 ...

    SQLServer2000高级编程技术（part02）-想学存储过程 SQL编程 务必要看

    第8章 确定专业的编程风格 8.1 源代码控制的概念 8.1.1 Microsoft Visual SourceSafe简介 8.1.2 管理Visual SourceSafe数据库 8.1.3 往Visual SourceSafe中添加一个数据库 8.1.4 管理存储过程 8.1.5 Visual ...

    hibernate 体系结构与配置 参考文档(html)

    DML(数据操作语言)风格的操作(DML-style operations) 14. HQL: Hibernate查询语言 14.1. 大小写敏感性问题 14.2. from子句 14.3. 关联(Association)与连接(Join) 14.4. join 语法的形式 14.5. select子句 ...

    SQLServer2000高级编程技术-已添加书签，想学存储过程、SQL编程务必要看，分析非常透彻

    第8章 确定专业的编程风格 8.1 源代码控制的概念 8.1.1 Microsoft Visual SourceSafe简介 8.1.2 管理Visual SourceSafe数据库 8.1.3 往Visual SourceSafe中添加一个数据库 8.1.4 管理存储过程 8.1.5 Visual ...

    Tcl_TK编程权威指南pdf

    它们提供了足够的可编程特性(变量、流程控制和过程)，使你可以将现有程序组装成符合自己需要的复杂的脚本程序。Shell程序非常适用于一些日常任务的自动化处理工作。 Tcl解释器可以很容易地添加到你的应用程序中，...

    Python核心编程(第二版).pdf （压缩包分2部分，第二部分）

    　第11章　函数和函数式编程　 　11.1　什么是函数？　 　11.1.1　函数vs过程　 　11.1.2　返回值与函数类型　 　11.2　调用函数　 　11.2.1　函数操作符　 　11.2.2　关键字参数 　11.2.3　默认参数　 　11.2.4　...

    Python核心编程(第二版).pdf (压缩包分2部分，第一部分)

    　第11章　函数和函数式编程　 　11.1　什么是函数？　 　11.1.1　函数vs过程　 　11.1.2　返回值与函数类型　 　11.2　调用函数　 　11.2.1　函数操作符　 　11.2.2　关键字参数 　11.2.3　默认参数　 　11.2.4　...

    C++Builder精彩编程实例集锦的源代码前3部分.rar

    实例051 如何在程序中设置Word文档的字体风格 实例052 如何使用Onldle事件 实例053 如何使程序在循环时响应外界事件 实例054 如何设置程序在系统启动时自动运行 实例055 如何创建多线程程序 实例056 如何创建可...

    PHP网络编程技术与实践 源码

    17.3.6 收藏、删除用户音乐以及查看点歌记录 17.4 管理员的管理程序 17.4.1 添加歌手 17.4.2 添加专辑 17.4.3 添加歌曲 17.4.4 修改与删除操作 17.4.5 审核歌词 17.4.6 设置推荐专辑 17.4.7 数据整理 17.5 本章小结 ...

    Python核心编程第二版(ok)

    　第11章　函数和函数式编程　 　11.1　什么是函数？　 　11.1.1　函数vs过程　 　11.1.2　返回值与函数类型　 　11.2　调用函数　 　11.2.1　函数操作符　 　11.2.2　关键字参数 　11.2.3　默认参数　 　11.2.4　...

    Java毕业设计-JAVA+SQL电子通讯录带系统托盘(论文+源代码).rar

    本资源不仅提供了详细的论文文档，包括需求分析、系统设计、实现细节和测试报告等，还附带了完整的源代码和数据库脚本，方便学生进行二次开发和定制。通过学习和实践本项目，学生可以深入理解Java编程技术和数据库...

    hibernate3.2中文文档（chm格式）

    Hibernate参考文档 3.2 -------------------------------------------------------------------------------- 目录 前言 1. 翻译说明 2. 版权声明 1. Hibernate入门 1.1. 前言 1.2. 第一部分 － 第一个...

    Hibernate 中文 html 帮助文档

    13.4. DML(数据操作语言)风格的操作(DML-style operations) 14. HQL: Hibernate查询语言 14.1. 大小写敏感性问题 14.2. from子句 14.3. 关联(Association)与连接(Join) 14.4. join 语法的形式 14.5. select子句 14.6...

Magicbox
Global site tag (gtag.js) - Google Analytics