Comments Plays an important role while writing efficient and clean code. Comments provide a great understanding of what is happening in the code and provides better readability. while working on big codebases a lot of comments are present. To automate fetching of comments from source file for documentation and other purposes this script is made
- Clone the folder
- Inside the folder open command line and run
- npm install
- node extractComments.js < Your source code file path>
- All comments will be written to an output.md file in the current directory
You will see the Line, Block and all type of comments written in output.md file
