毕业论文论文范文课程设计实践报告法律论文英语论文教学论文医学论文农学论文艺术论文行政论文管理论文计算机安全
您现在的位置: 毕业论文 >> 报告 >> 正文

计算机源代码编写规范GNU编码规范 第2页

更新时间:2014-6-15:  来源:毕业论文
3.3修改日志(Change Logs)
为每个目录文护一个修改日志,以记述对这个目录下源文件的修改。这样做的目的是使得 在将来寻找bug的人可以指导大致是那些修改导致了错误。通常,一个新的bug可以在最近进行 的修改中被找到。更重要的事,修改日志有助于消除程序的不同部分之间在概念上的不一致性; 它们可以告诉我们概念冲突产生的历史。 本文来自优.文,论-文·网原文请找腾讯752018766
使用Emacs命令M-x add-change在修改日之中创建一个新的条目。一个条目应该 包含一个星号、被修改的文件的名称以及被扩在括号内的、被修改了的函数、变量或者任何东西。 括号之后是冒号和对你对函数或变量的修改的说明。
用空行把无关的条目分隔开。如果两个条目反映了同一个修改,因而它们一同工作,那就不要 在它们之间使用空行。如果后续的条目针对的是相同的文件,那么你可以忽略文件名的星号。
下面是一些例子:
* register.el (insert-register): Return nil.
(jump-to-register): Likewise.

* sort.el (sort-subr): Return nil.

* tex-mode.el (tex-bibtex-file, tex-file, tex-region):
Restart the tex shell if process is gone or stopped.
(tex-shell-running): New function.

* expr.c (store_one_arg): Round size up for move_block_to_reg.
(expand_call): Round up when emitting USE insns.
* stmt.c (assign_parms): Round size up for move_block_from_reg.
在这里没有必要叙述修改的完整目录和它们是如何协同工作的。把这些说明作为注释放到 代码中更好一些。这就是说为什么只要给出“New function”就够了;在源代码中,与函数 放在一起的注释说明了它是做什么的。
然而,有时为一大堆修改写上一行文字以描述它们的整体目的是有用的。
在概念上,你可以把修改日志看作解释原始版本与当前版本的不同的“undo列表”。 人们可以阅读当前的版本;他们不需要修改日志告诉他们其中有什么。他们从修改日之中 得到的是关于早期版本的不同的清晰解释。
在你以简单的方式修改函数的调用顺序,并且你修改了所有对函数的调用时,不必为所有 的调用创建单独的条目。只要在被调用的函数的条目中写“All callers changed.”即可。
在你仅仅修改了注释或者文档字符串的时候,为该文件写一个条目,而不必提到函数, 就足够了。只要写"Doc fix."。不必为文档文件文护修改日志。这是因为文档不那么容易 受到难以修正的错误的影响。文档不是由那些必须以精确地工程方式相互作用的部分组成的; 要修改一个错误,你不需要知道这个错误传播的历史。
3.4与其它实现的兼容性
作为一个特例,对于GNU中的工具程序和库,它们应该和Berkeley Unix相应的部分向上兼容, 如果标准C定义了它们的行为,那它们应该和标准C向上兼容,如果POSIX规范定义了它们的行为, 那它们也应该与POSIX规范向上兼容。
当这些标准发生冲突的时候,为每个标准提供兼容模式是有用的。
标准C和POSIX禁止进行任何形式的扩展。自由地进行你的扩展,并且把选项 `--ansi'或`--compatible'包括进来以关闭你的扩展。 但是如果扩展很可能导致任何实际程序或者脚本的崩溃,那么它可能实际上不是向上兼容的。 尝试一下重新定义它的界面。 本文来自优.文,论-文·网原文请找腾讯752018766
当一个特征仅仅被用户(而不会被程序或者命令文件)所使用的时候,并且在Unix中它完成得 并不好,请自由地用完全不同并且更好的方式代替它。(例如,用Emacs代替vi。)但同时提供兼容 模式仍然是很好的。(现在有自由的vi实现,所以我们提供了它。)
欢迎提供Berkeley Unix没有提供的有用功能。Unix中没有的附加功能可能是有用的,但我们 优先复制那些Unix已经有的功能。 Makefile惯例

上一页  [1] [2] [3] [4] [5] 下一页

计算机源代码编写规范GNU编码规范 第2页下载如图片无法显示或论文不完整,请联系qq752018766
设为首页 | 联系站长 | 友情链接 | 网站地图 |

copyright©youerw.com 优文论文网 严禁转载
如果本毕业论文网损害了您的利益或者侵犯了您的权利,请及时联系,我们一定会及时改正。