Free comment software for linux

Acme::Comment is a Perl module that allows multi-line comments which are filtered out.

SYNOPSIS

use Acme::Comment type=>C++, own_line=>1;

/*
if (ref $mod) {
$bar->{do}->blat(msg => blarg);
eval {

im sooo sick of this time for some coffee

*/

// I prefer beer. --sqrn

Unlike the pseudo multi-line comment if (0) {}, the code being commented out need not be syntactically valid.

Photocomments project convert various forms of comments and descriptions from digital photos.
Supports descript.ion files (as used by ACDsee), jpeg internal comments and CSV files for use with gallery
Written in perl. Uses ImageMagick for the jpeg comment stuff.
Main features:
- Convert different forms of comments for jpeg photos.
- Why? One picture viewer is good for editing comments, another one is good for viewing the images and then theres my online gallery, which should also use the comments as captions.
- Can read descript.ion files (acdsee) and jpeg comments
- can write: descript.ion files, jpeg comments, gallery-csv-files (needed for import to gallery)
- Caveeat: Cannot handle filenames with spaces.

Pod::InComments is a Perl extension for extracting POD documentation from comments in config file.

SYNOPSIS

use Pod::InComments;
my $podparser = Pod::InComments->new( comment => ; );
$podparser->ParseFile( $my_config_file );
$podparser->Pod2Hash();

my $helptext = $podparser->Pod4Section( $section , $key );

This module was written to solve the problem of describing numerous parameters in a config file. When you add comments to the config file, it becomes a mess quickly. And no-one will take the time to properly read them. You can not add POD directly. So..... here is Pod::InComments.

It was developed when using Config::IniFiles format, so lets take that as the basis. The Config::IniFiles module lets you use config files in the form of the popular windows ini file. That is, they look like

[section]
param1=some value
param2 = another value
param3=20.00

; this is a comment
[operating system]
preferred=Linux
using=Windows XP Pro

METHODS

new( comment => # )

Constructor of the class. Specify the comment character(s) used in the config file. Defaults to ;. You can use whatever you like here. So #### is valid as well, but requires more typing in the config.

ParseFile( $config_file )

Parses the $config_file and extracts all the comment lines. The comment character(s) are stripped of each line. It returns a string with all the POD.

Pod2Hash()

After parsing a config file, you will need to call this function to convert the POD into a hash. The keys of the hash are the head1 titles. If head2 elements are present, they will be subkeys of the hash.

Pod4Section( $section, $param )

Returns the POD belonging to the $section, or to $param of $section.

E.g., when your config file looks like:

;=head1 cpu
;
;Specifies cpu settings for normal boxes
;note that these will override factory settings!
;
;=head2 maxload
;
;The maxload setting gives an upperbound on how hard
;the CPU can be pushed.

[cpu]
maxload=4.0

then doing:

my $pod = $podparser->Pod4Section( cpu, maxload );

will give you:

The maxload setting gives an upperbound on how hard the CPU can be pushed.

SavePod( $file )

Saves the extracted pod to the $file. If you omit a file name, it will append .pod to the config file you parsed and saves to that file.

GetPod()

Returns the entire POD formatted in text.

DisplayPod()

Prints the entire extracted POD documentation to STDOUT.

Smart::Comments are comments that do more than just sit there.

SYNOPSIS

use Smart::Comments;

my $var = suspect_value();

### $var

### got: $var

### Now computing value...

# and when looping:

for my $big_num (@big_nums) { ### Factoring... done
factor($big_num);
}

while ($error > $tolerance) { ### Refining---> done
refine_approximation()
}

for (my $i=0; $i<<less