This repo is useful for developers who would like to document their source code for php and js. The process starts two docker containers for PHPDocumentor 3 and JsDocs. The script will pull source code from a remote repository, document the code, then commit changes to the documentation repository.
Software development projects can be large with extremely complex functionality so managing them can be very difficult without a good road map, dedicated project management software, and effective processes such as Agile. One feature of software projects, often overlooked, are good tech libraries with detailed discussions, notes, and indexes for files, functions, and events. Yes, git repositories document code using commit ids and pull requests however this kind of documentation is rarely referenced unless there is a need to troubleshoot.
Many times developers re-invent routines, classes, or entire programs, sometimes within the same organization, because there is a lack of developers’ documentation. Documenting processes or commenting code are practices that should be re-invented, especially developers early in their careers or experienced developers new to the project and codebase.
PHP Documentor and JSDOCS are two programs developers can use to automatically document their code and build tech libraries as projects are completed. One goal in a developer’s shop is to find reusable code that could be used to build larger software components or assemblies. This kind of documentation helps establish coding standards, best practices, and communicate parts of the software still in development or stages of testing. Managers can perform better code reviews and developers can examine their own code in greater detail and context for possible improvements.
