SubText
Discovers and builds documentation dynamically
SubText
Category
License
Development Status
Company
Latest VersionCollaboration
Free
For further development
Team in a Box
N/A
SubText discovers and builds documentation dynamically by using a language similar to AspectJ's pointcuts. This enables designers and developers to present crosscutting documentation where it is actively needed during development.
There are several advantages of SubText:
- System level design and architecture decisions are often not visible at the detailed level of writing code.
- SubText can help new developers understand pattern-rich codebases. Generic documentation for well-known design patterns and idioms can be added to any project helping new developers to understand how things work.
- Code quality can be improved by providing information about how types should be implemented or extended, and where they should and should not be used.
- Developers can continuously refactor and add to SubText documents during a project. Since SubText documents are lightweight, there isn't a lot of overhead. The result is a set of SubText documents which accurately reflect the design and code of the system being developed.
- Future versions could provide a reverse lookup: which types are involved in feature X?