Add comments to exported functions, methods, types in a golang source tree

addcomments.pl

my $path = $ARGV[0];

# print $path;

open(my $file, "<", $path) or die "Unable to open file, $!";

my $contents = do { local $/; <$file> };
close $file;

# print $contents;

# functions
$contents =~ s/(\nfunc\s+)([A-Z][a-zA-Z0-9_]*)/\n\/\/ $2 .....$1$2/sg;

# methods
$contents =~ s/(\nfunc\s+\([^\)]*\)\s+)([A-Z][a-zA-Z0-9_]*)/\n\/\/ $2 .....$1$2/sg;

# types
$contents =~ s/(\ntype\s+)([A-Z][a-zA-Z0-9_]*)/\n\/\/ $2 .....$1$2/sg;


# print $contents;
# print "\n";


open(my $outfile, ">", $path) or die "Unable to open outfile, $!";
print $outfile $contents;

run.sh

find ./pkg -type f -name "*.go" -exec perl addcomments.pl {} \;