Hot answers tagged

60

Because the standard writers don't want to actually assert an implementation. They want to define what it does, but not necessarily how it does it. So, for example, if you look at the GNU C++ version of find_if, you will see that the implementation is slightly different from what you give, which is based on the C++ standard: template<typename ...


5

Data Flow Diagrams sound like what you need From Wikipedia: A data flow diagram (DFD) is a graphical representation of the "flow" of data through an information system, modelling its process aspects. A DFD is often used as a preliminary step to create an overview of the system, which can later be elaborated.2 DFDs can also be used for the visualization ...


1

Code examples should illustrate usage. For example, here is a comment I wrote for a business rules engine in C#: /// <summary> /// Creates Linq Expressions that represent validation rules, and compound expressions /// representing rule sets via the use of the And and Or methods below. /// </summary><remarks> /// This class is a ...


1

Generally speaking - use Markdown format. Most document generators can read markdown files to include in their documentation output. Doxygen, for example, can include markdown text inline or from external files. Whether examples should be complete or not is up to you. Some complex examples show just the necessary code so the extraneous parts do not get in ...


1

It sounds like package management (e.g. in Linux distribution). You should list dependencies. There are several package formats on Linux (e.g. .deb & .rpm)



Only top voted, non community-wiki answers of a minimum length are eligible