记录程序架构 [英] Documenting program architecture

问题描述

人们发现有什么有效的方法记录一个大型项目的架构，使代码新手的程序员可以快速相对地得到他们的支持？

解决方案

启动visio并开始画画。当涉及到架构时，我发现图表是一个很好的方法来获得所有组件如何组合在一起的高级感觉。

显然，一个图表是不够的所以一旦我有了这个图表，它显示了所有的零件是如何组合在一起的，那么我就想详细的记录每个组件。

我要注意的主要事情是：

• 耦合（取决于这个
  部分以及它取决于什么）
  组件的目的


• 组件的目的


• 底层技术


• 选择实现组件的主要原因其实现方式

还有其他一些你可以谈论的东西，但那些是主要的

What have people found to be effective methods of documenting the architecture of a large project so that programmers new to the code can "get their bearings" (relatively) quickly?

解决方案

Fire up visio and start drawing. When it comes to architecture, I find that diagrams are a great way to get a high level feel for how all the components fit together.

Obviously a diagram isn't enough, so once I have the diagram which shows how all the parts fit together, I then like to document each component in detail.

The main things I'll note are:

• The couplings (what depends on this part and what it depends on) the purpose of the component
• The purpose of the component
• The underlying technology
• The key reasons for choosing to implement the componet in the way it has been implemented

There are other things you can talk about but those are the main ones

这篇关于记录程序架构的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！