Beefy Boxes and Bandwidth Generously Provided by pair Networks
No such thing as a small change

Comment on

( #3333=superdoc: print w/replies, xml ) Need Help??
    This is my first Perl developing contract. I have been in this company for approx less than 4.5 months. Initially it was a 3 month contract, and then at the end of the 3rd month, it was extended to another month. Off course I wasn’t happy with this arrangement, but there wasn’t anything I can do about it.


Why did you stay if you weren't happy?

    My boss has asked me to give him the source code to an application that I have developed – that the full cycle, from the concept, design, coding, testing, documentation and deployment. The problem is he has also have asked me to comment every single line the code. He explained that he needs to know what every single line does, by the way he is not a developer nor had development background.

Well, there's no need to take him literally: you probably don't need to put a comment on each line. However, you probably do need to write a comment block for each group of lines.

Here's some recent code of mine:

# Get the Form object and collect the variable # information as submitted. my $Form = new CGI; my $Vars = $Form->Vars; # Encode apostrophes so MySQL doesn 't worry. foreach ( keys %{ $Vars } ) { $Vars->{ $_ } =~ s/'/\\'/g; }

I don't have every line commented, but the comments are frequent enough that I feel it's sufficiently documented.

    More requests came in to add more facilities and functions to the script, in other words ”they kept moving the goal post”, the goal post are so far apart I can’t see any of the posts anymore.

This is a problem? It sounds like they loved your work and because you were working out, they wanted to add more functionality. That sounds like a win-win situation to me.

    Nothing my contract explicitly says that I should comment every single line of my code before I leave so they can bring any Jerko to take over the script? Can they?

Yes, they can bring anyone in to work on the script you developed. You're under contract to them, they own whatever you develop for them.

Now, if the new guy calls up asking questions, be helpful for the first 15 minutes, but after that you can suggest that your time is billable and perhaps the new guy should get the client to authorize payment for some of your time.

--t. alex
but my friends call me T.

Update: Try to fix formatting with opening *and* closing p tags. Content has not changed.

In reply to Re: Perl contract problems by talexb
in thread Perl contract problems by blackadder

Use:  <p> text here (a paragraph) </p>
and:  <code> code here </code>
to format your post; it's "PerlMonks-approved HTML":

  • Posts are HTML formatted. Put <p> </p> tags around your paragraphs. Put <code> </code> tags around your code and data!
  • Titles consisting of a single word are discouraged, and in most cases are disallowed outright.
  • Read Where should I post X? if you're not absolutely sure you're posting in the right place.
  • Please read these before you post! —
  • Posts may use any of the Perl Monks Approved HTML tags:
    a, abbr, b, big, blockquote, br, caption, center, col, colgroup, dd, del, div, dl, dt, em, font, h1, h2, h3, h4, h5, h6, hr, i, ins, li, ol, p, pre, readmore, small, span, spoiler, strike, strong, sub, sup, table, tbody, td, tfoot, th, thead, tr, tt, u, ul, wbr
  • You may need to use entities for some characters, as follows. (Exception: Within code tags, you can put the characters literally.)
            For:     Use:
    & &amp;
    < &lt;
    > &gt;
    [ &#91;
    ] &#93;
  • Link using PerlMonks shortcuts! What shortcuts can I use for linking?
  • See Writeup Formatting Tips and other pages linked from there for more info.
  • Log In?

    What's my password?
    Create A New User
    and all is quiet...

    How do I use this? | Other CB clients
    Other Users?
    Others avoiding work at the Monastery: (8)
    As of 2018-06-18 20:14 GMT
    Find Nodes?
      Voting Booth?
      Should cpanminus be part of the standard Perl release?

      Results (110 votes). Check out past polls.