README

Comments exporter is a console script that can export code comments from multiple source files to a csv file. This file can be used to perform bulk proofreading and editing over code comments. After that, comments can be imported back with the same script.

Script supports all types of C-like comments, such as:

// This one.
/* This one. */
/**
 * And this one. 
 */

Installation

Requirements:

• PHP7
• Composer

Comments exporter is installed as a global Composer package. You need to have Composer installed in your system and have the composer global tools added to your PATH.

composer global require shvetsgroup/comments-exporter

Updates

composer global update shvetsgroup/comments-exporter

Usage

1. Export comments:

   comments-exporter export /path/to/project /path/to/csv-file.csv
   

2. Do something with the csv-file.csv contents. Do not add new rows, just edit the comment column.

3. Import comments back:

   comments-exporter import /path/to/csv-file.csv /path/to/project 
   

Type comments-exporter --help to read about full list of supported parameters.