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

webcommon.urlencode

WebCommon.urlEncode(3kaya)				       Kaya module reference					WebCommon.urlEncode(3kaya)

NAME

       WebCommon::urlEncode - URL encode a string

SYNOPSIS

       String urlEncode( String x )

ARGUMENTS

       x The string to encode

DESCRIPTION

       URL encode a string. You should use this to encode reserved characters in URLs that you wish to be passed literally.

    // trying to pass "http://www.example.com" as a parameter
    url = "http://localhost/test.cgi?url=";
    url += urlEncode("http://www.example.com");
    // url = http://localhost/test.cgi?url=http%3A%2F%2Fwww.example.com

       Note that in the example above, encoding the whole URL would be incorrect - that would create a relative URL beginning "http://".

AUTHORS

       Kaya standard library by Edwin Brady, Chris Morris and others (kaya@kayalang.org). For further information see http://kayalang.org/

LICENSE

       The  Kaya  standard  library  is  free  software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public
       License (version 2.1 or any later version) as published by the Free Software Foundation.

RELATED

       WebCommon.urlDecode(3kaya)

Kaya								   October 2012 					WebCommon.urlEncode(3kaya)