Self Documenting Code Post: 302770205

6 More Discussions You Might Find Interesting

1. UNIX for Dummies Questions & Answers

Documenting a Shell Script

I've been working on a very long shell script that's becoming a mini-application. It is my first script, and continues to grow each week, becoming more and more complex. I've been asked to document my script, beginning with basic information and then detailing any information about its...

2. UNIX for Dummies Questions & Answers

Any easy way of documenting cron entries?

I've been asked to do a high level summary of the cron jobs which run against a number of systems (to understand the potential scope for rewriting some of our core systems)...and was wondering how people have done this in the past. I've got approx 400 cron entries to go through. I will have...

3. Programming

Documenting code

I am programming using C++ and am wondering how to comment my project. For example, when I declare a class I created a header with some description, then have the declaration stage, which I don't comment. Then when I define the actual functions I will put details about it, what it does,...

4. Shell Programming and Scripting

Script Help -- documenting specific users that log into server

Hello All, I am trying trying to write a shell script that will do a couple things: 1.) Identify any username that logs into the server. 2.) When the user logs out, send them an email detailing their log in/out times, duration logged in, and what processes they ran. Basically,...

5. Shell Programming and Scripting

Documenting files with sed

All, I am looking for a way to improve this small one liner. one of the files has this kind of format public func <<<T>(array: , offset: Int) -> { return array.shiftedLeft(by: offset) } gsed -i '/public func/i /\/\/\public func \n/\/\==mark==public func' tresults in ///public func ...

6. Web Development

Documenting Installation Problem with vue-beautiful-chat

REF: https://github.com/mattmezza/vue-beautiful-chat $ git clone https://github.com/mattmezza/vue-beautiful-chat.git Cloning into 'vue-beautiful-chat'... remote: Enumerating objects: 534, done. remote: Total 534 (delta 0), reused 0 (delta 0), pack-reused 534 Receiving objects: 100%...

LEARN ABOUT DEBIAN

ppix::regexp::structure::code

PPIx::Regexp::Structure::Code(3pm)			User Contributed Perl Documentation			PPIx::Regexp::Structure::Code(3pm)

NAME

       PPIx::Regexp::Structure::Code - Represent one of the code structures.

SYNOPSIS

	use PPIx::Regexp::Dumper;
	PPIx::Regexp::Dumper->new( 'qr{(?{print "hello sailor
")}smx' )
	    ->print();

INHERITANCE

       "PPIx::Regexp::Structure::Code" is a PPIx::Regexp::Structure.

       "PPIx::Regexp::Structure::Code" has no descendants.

DESCRIPTION

       This class represents one of the code structures, either

	(?{ code })

       or

	(??{ code })

METHODS

       This class provides no public methods beyond those provided by its superclass.

SUPPORT

       Support is by the author. Please file bug reports at <http://rt.cpan.org>, or in electronic mail to the author.

AUTHOR

       Thomas R. Wyant, III wyant at cpan dot org

COPYRIGHT AND LICENSE

       Copyright (C) 2009-2012 by Thomas R. Wyant, III

       This program is free software; you can redistribute it and/or modify it under the same terms as Perl 5.10.0. For more details, see the full
       text of the licenses in the directory LICENSES.

       This program is distributed in the hope that it will be useful, but without any warranty; without even the implied warranty of
       merchantability or fitness for a particular purpose.

perl v5.14.2							    2012-06-06					PPIx::Regexp::Structure::Code(3pm)