shvetsgroup/comments-exporter

A console script that exports source code comments to csv files and vise versa. Supports most types of comments, both single and multi-line.

Comments exporter

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., _(*1)

Script supports all types of C-like comments, such as:, _(*2)

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

Installation

Requirements:, _(*3)

• 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., _(*4)

composer global require shvetsgroup/comments-exporter

Updates, _(*5)

composer global update shvetsgroup/comments-exporter

Usage

1. Export comments:, _(*6)

   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., _(*7)

3. Import comments back:, _(*8)

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

Type comments-exporter --help to read about full list of supported parameters., _(*9)