Book Image

The Complete Edition - Software Engineering for Real-Time Systems

By : Jim Cooling
Book Image

The Complete Edition - Software Engineering for Real-Time Systems

By: Jim Cooling

Overview of this book

From air traffic control systems to network multimedia systems, real-time systems are everywhere. The correctness of the real-time system depends on the physical instant and the logical results of the computations. This book provides an elaborate introduction to software engineering for real-time systems, including a range of activities and methods required to produce a great real-time system. The book kicks off by describing real-time systems, their applications, and their impact on software design. You will learn the concepts of software and program design, as well as the different types of programming, software errors, and software life cycles, and how a multitasking structure benefits a system design. Moving ahead, you will learn why diagrams and diagramming plays a critical role in the software development process. You will practice documenting code-related work using Unified Modeling Language (UML), and analyze and test source code in both host and target systems to understand why performance is a key design-driver in applications. Next, you will develop a design strategy to overcome critical and fault-tolerant systems, and learn the importance of documentation in system design. By the end of this book, you will have sound knowledge and skills for developing real-time embedded systems.
Table of Contents (16 chapters)
Preface
15
Glossary of terms

14.5 Source Code Aspects

14.5.1 Source Code Documentation – a Philosophy

Requirements. Design. Test. There are boundless numbers of small projects where no formal (sometimes just no) documentation exists for these items. However, every software project has source code. Thus, it is worth looking at this topic in somewhat more detail (especially from the point of view of the individual programmer – for example, you). The ideas expounded here are aimed at two groups in particular:

  • Novice programmers
  • Experienced programmers who believe that documentation is for quiche-eaters and Ada developers

Both tend to have a very myopic, narrow view of program writing and development. Everything is done from their point of view, for their (often, immediate) convenience, in the easiest, quickest fashion. In many cases, the source code "documentation" includes the files submitted to the compiler. The content and format of such documentation depend on the...