Self Documenting Code

 
Thread Tools Search this Thread
The Lounge What is on Your Mind? Cartoons for Geeks Self Documenting Code
# 1  
Old 02-14-2013
Self Documenting Code

2013-02-14T23:10:20+01:00
Image


Tweet
Image Image Image Image
Image

Source...
 
Login or Register to Ask a Question

Previous Thread | Next Thread

6 More Discussions You Might Find Interesting

1. 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%... (2 Replies)
Discussion started by: Neo
2 Replies

2. 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 ... (5 Replies)
Discussion started by: f77hack
5 Replies

3. 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,... (3 Replies)
Discussion started by: SecureScript
3 Replies

4. 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,... (2 Replies)
Discussion started by: kristinu
2 Replies

5. 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... (2 Replies)
Discussion started by: GavP
2 Replies

6. 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... (1 Reply)
Discussion started by: yongho
1 Replies
Login or Register to Ask a Question
PPIx::Regexp::Token::Code(3)				User Contributed Perl Documentation			      PPIx::Regexp::Token::Code(3)

NAME
PPIx::Regexp::Token::Code - Represent a chunk of Perl embedded in a regular expression. SYNOPSIS
use PPIx::Regexp::Dumper; PPIx::Regexp::Dumper->new( 'qr{(?{print "hello sailor "})}smx')->print; INHERITANCE
"PPIx::Regexp::Token::Code" is a PPIx::Regexp::Token. "PPIx::Regexp::Token::Code" is the parent of PPIx::Regexp::Token::Interpolation. DESCRIPTION
This class represents a chunk of Perl code embedded in a regular expression. Specifically, it results from parsing things like (?{ code }) (??{ code }) or from the replacement side of an s///e. Technically, interpolations are also code, but they parse differently and therefore end up in a different token. This token may not appear inside a regex set (i.e. "(?[ ... ])". If found, it will become a "PPIx::Regexp::Token::Unknown". METHODS
This class provides the following public methods. Methods not documented here are private, and unsupported in the sense that the author reserves the right to change or remove them without notice. ppi This convenience method returns the PPI::Document representing the content. This document should be considered read only. 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-2013 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.16.3 2014-06-10 PPIx::Regexp::Token::Code(3)