Skip to content

Documenting Source Code Directories

The above image illustrates the directory structure of a mock project.

  • “Data” directory stores SAS datasets.
  • “Doc” directory stores web documentation generated by DocItOut.
  • “Src” directory stores source codes. In this scenario, this directory contains two subdirectories: one subdirectory contains data entry related programs and another contains reporting related programs.

The above image illustrates the “Overview” page of the web documentation generated by DocItOut. As you can see, the second column of the table is empty.

In order to add some description of a directory, you need to create and place a “readme.txt” file in each directory. The file content may look something like this:-

Contains all reporting related programs.

You can also use HTML tags in the readme.txt file:-

<p>
Contains all reporting related programs. This set of program is primarily maintained by <i>an intern</i>. Thus it is bound to have <b>fatal errors</b>. :)
</p>
<p>
Nevertheless, feel free to browse through it.
</p>

With these readme.txt files, DocItOut extracts the first line from the readme.txt and places it in the second column of the table. The full directory description will be shown when a particular directory is selected from the table.

%d bloggers like this: