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
sccshelp(1)						      General Commands Manual						       sccshelp(1)

NAME
sccshelp - Provides information about a Source Code Control System (SCCS) message or command SYNOPSIS
sccshelp [error_code] [sccs_command] DESCRIPTION
The sccshelp command displays information about the use of a specified SCCS command or about messages generated while using the commands. Each message has an associated error code, which can be supplied as an argument to the sccshelp command. You can supply zero or more arguments. If you do not supply an argument, sccshelp prompts for one. You can include any of the SCCS commands as arguments to sccshelp. The error_code argument specifies the code, consisting of numbers and letters, that appears at the end of a message. For example, in the following message, the error code is cm7: There are no SCCS identification keywords in the file. (cm7) Compatibility Notes The SCCS help command was changed to sccshelp; the help command now provides information about the operating system. EXAMPLES
To get sccshelp on rmdel and two error codes, enter: sccshelp rmdel gee ad3 The sccshelp command displays: rmdel: usage: rmdel -rSID {file ... | Directory | -} Removes a Delta from a Source Code Control System File. The header flag you specified is not recognized. The header flag you supplied with the -d or -f flag is not correct. Choose a valid header flag. FILES
Directory containing files of message text. SEE ALSO
Commands: admin(1), cdc(1), comb(1), delta(1), get(1), prs(1), rmdel(1), sact(1), sccs(1), sccsdiff(1), unget(1), val(1), what(1) Files: sccsfile(4) Programming Support Tools sccshelp(1)