From d4dcfa822d7aadbbf939f66d6550dcaf395543f9 Mon Sep 17 00:00:00 2001 From: Hui Lan Date: Sun, 25 Jul 2021 15:56:47 +0800 Subject: =?UTF-8?q?parnas-a-rational-design-process.rst:=20=E8=9E=8D?= =?UTF-8?q?=E5=85=A5=E5=AD=A3=E6=95=AC=E8=B6=85=E7=9A=84=E7=BF=BB=E8=AF=91?= =?UTF-8?q?=20(PDF=20page=2015).?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- parnas-a-rational-design-process.rst | 24 ++++++++---------------- 1 file changed, 8 insertions(+), 16 deletions(-) (limited to 'parnas-a-rational-design-process.rst') diff --git a/parnas-a-rational-design-process.rst b/parnas-a-rational-design-process.rst index df6fb72..ee461d0 100644 --- a/parnas-a-rational-design-process.rst +++ b/parnas-a-rational-design-process.rst @@ -429,33 +429,25 @@ E. 设计并且记录使用层级 (uses hierarchy) Page 14 ------------------------------------------------------------------------------ -(陈肖飞 翻) +(陈肖飞 翻， 季敬超 改) F. 编写程序 ```````````````````````````````````````````````````````````````````````````````` -在设计和文档编制完成后，我们就可以编写代码了。我们发现这件事进展的迅速 -而顺利。我们认为，代码注释不应该包含文档中已经有的内容。否则，系统维护 -会更加昂贵，同时增加了代码与文档不一致的可能性。（因为会出现注释改了， -而忘了更新对应位置的文档。或者文档改了，而忘了更新对应位置的注释。） +完成所有这些设计和文档之后，我们就已经准备好编写实际的可执行代码了。我们发现编写过程快速而流畅。我们认为，代码注释不应该包含文档中已经写有的内容。这是不必要的，这会使维护系统更加昂贵，同时增加了代码与文档不一致的可能性。 +（因为会出现代码注释改了，而忘了更新对应位置的文档。或者文档改了，而忘了更新对应位置的代码注释。-- 译者注） -VI.文档在这一过程中的作用是什么？ +VI.文档在这此过程中的角色是什么？ ``````````````````````````````````````````````````````````````````````````````` -A． 当前的文档有什么问题？ 为什么它不便使用？ 为什么它晦涩难懂？ +A． 当前的文档有什么问题？ 为什么它难用？ 为什么没有人读它？ -很明显，文档在我们描述的设计过程中扮演着重要角色。大多数程序员认为文档 -是一种必要的累赘，是在事后才做的，只是因为有些官僚需要文档。但我们认为， -在发布之前都没有使用过的文档一定是糟糕的文档。 +应该清楚的是，文档在我们描述的设计过程中扮演着重要角色。大多数程序员视文档为不得不写的麻烦事，是在事后才写的，只是因为有些官僚需要它才写的。我们认为，在发布之前未被使用过的文档将是糟糕的文档。 -多数文档不完整不准确，但这并不是主要的问题。如果是的话，只要简单地添加 -或者纠正信息就可以纠正它们。事实上，有一些根本的文档组织结构问题才是导 -致不完整和不准确的原因，而且这难以修复: +大多数这种文档不完整且不准确，但这写并不是主要问题。如果是，只需添加或更正信息就可以改正它们。事实上，这些文档中潜在的组织问题导致了不完整与错误，且难以修复: -- 糟糕的组织。今天的大多数文档可以被描述为“意识流”和“执行流”。意识流写 - 作将信息放在作者写作的时候突然想到的那个点上。执行流描述了系统在运行 - 时发生的事情的顺序。 +- 糟糕的组织。今天大多数文档可以被描述为“意识流”和“执行流”。意识流写作是想到哪里就写到哪里。执行流写作是按照系统运行时事情发生的顺序来描述系统。 -- cgit v1.2.1