撸撸射网站

声明：对于代码阅读的接头，许多念念想和翰墨是来自《代码阅读》这本书，再加上我方的学习和责任锤真金不怕火。不错说是访佛念书札记的，我把它当作了毕业论文的第8章，并聚积了我方的毕设作品进行解说，毕设源代码github下载地址：https://github.com/chinaran/A-LL1-Compiler。

8.4 边幅文档

任何紧要的软件开辟边幅都很有可能随同产生大批的文档。这些文档有很厚爱的，也有比拟减轻的。欺骗边幅中常见的典型文档，不错匡助开辟者交融软件代码。

8.4.1 文档类型

系统规格讲明文档（System Specification Document）用于详备刻画系统的主义、功能性条目、惩办和手艺上的抑遏，以及资本和日程界限。系统规格讲明文档有助于交融所读代码的脱手环境。

软件需求规格讲明（Software Requirements Specification）用于提供对于用户需乞降合座系统架构的高档刻画，详备讲明了各式功能性和非功能性需求，比如数据处理、外部接口、逻辑数据库现象，以及筹商上的种种拘谨。（编译系统参见doc下的软件需求讲明书.doc文献）

筹商规格讲明（Design Specification）包含有对系统架构、数据、代码结构以及模块迤逦口的刻画。细化的筹商规格讲明还会包含每一个模块和类的具体信息撸撸射网站，其中还可能会接洽于系统使用的数据结构和适用的数据库现象的刻画。总之，筹商规格讲明不错看作是一份代码结构指南，一册接洽特定代码的手册。（编译系统参见doc下的数据库筹商文档.doc文献）

系统测试规格讲明（System’s Test Specification）一般刻画测试忖度、具体的测试历程和本色的测试成果，还应包含用于测试责任的测试用例。测试规格文档不错提供一些数据用来推演相干代码。（编译系统参见doc下的软件测试阐扬.doc文献）

用户文档（User Documentation）是由许多不同的文档麇集在一皆的，包括功能性刻画、安设讲明、初学指南、参考手册和惩办手册。

8.4.2 阅读文档的作用

● 文档不错匡助你很快了解一个系统的大体情况，交融提供特定功能的才气代码。

● 文档会提供系统的规格讲明，可据此对代码进行审查。

● 文档常常好像反应并进而揭示一些底层结构。

● 文档不错匡助交融较为复杂的算法和数据结构。

● 文档普通会对源代码符号符的含义进行解说。

● 文档不错提供非功能性需求背后的表面复古。

● 文档中还常常不错反应筹商者的一些念念考：系统需求、架构和完了上的主义、主义以及意图；一些被否决的备选决策过甚否决原因。

● 文档普通也会刻画完了中的一些已知的问题和bug。

8.4.3 文档中存在的问题

在阅读文档时代要留意，文档或然会提供不正确的信息，误导咱们对源代码的交融。一是未纪录的特点，或然代一些特点莫得被纪录在文档中纯正是由于轻薄所致，异常是那些在居品开辟后期才加进来的特点。二是梦想化的抒发，文档或然对系统刻画时撸撸射网站，并不是按照系统还是完了出来的式样，而是按照系统应该发扬或将要发扬出来的式样。总之，开辟者恒久应以批判的念念维来阅读文档。因为文档从来不会实行，同期也很少被测试或厚爱复查。