How to write comments suitable for automatic software indexing1
This paper proposes a strategy for writing the comments (that is, natural-language text) embedded in the source code of software components. The novelty of the strategy is that it suggests to proceed step by step starting from given specifications. At the end of the writing process we have, besides the comments themselves, a set of indices forming a short description of the software component (its profile), which is much easier to manipulate than the full text. By storing profiles into a database a software catalog is built. The availability of software catalogs is strategic to locate reusable components matching specific requirements.
software catalog automating indexing free-text indexing code reusability