Yep.
I have come to the conclussion, esp being aware that others will often be maintaining my code in the future, that I should look to committing myself to having a help file writer open while I code, and both better comment my code, and add references pointing to the help file, where useful info may be found.
Then include the developer's CHM helpfile as a resource in the exe and provide a menuitem in help for getting it onto hard drive (if not present already) and opened up.
A small ask on me really compared to the headaches that someone else may end up with.
paul
On 05/05/06, Kyley Harris <[EMAIL PROTECTED]> wrote:
You beat me to it. I agree with most of John's statements about headers
etc. and why you cant trust source control unless you will stick with it
for life on the same system.
But Superb Programmer? Perhaps you meant Intelligent Person? There are
plenty of Geniuses, engineers, mathematicians etc, who all code because
it helps their other jobs. Programming is a role itself, that does not
require skills in all these other areas. A Suberb programmer should in
the least:
Write clean consistent code.
Write self documenting code.
Also write supplementary comments regarding complex self-documenting
code.
Understand the goal, before starting the task.
A Suberb programmer, does not need to know maths etc. This is all
available in books and specs. A Suberb programmer knows how to take all
the bits and pieces and turn it into maintainable, clean, bug free
software. I am guessing that most Delphi group people are a mixture of
Programmer, Self-manager, etc. Not everyone works corporate. But its
important to distinguish the skill of programming, aside from the skills
of other mixed roles.
-----Original Message-----
From: [EMAIL PROTECTED] [mailto:[EMAIL PROTECTED] ]
On Behalf Of Todd Martin
Sent: Friday, 5 May 2006 3:49 p.m.
To: [EMAIL PROTECTED]; NZ Borland Developers Group - Delphi List
Subject: Re: [DUG] Naming your code
I assume you're joking. That's not my idea of 'superb programming'.
> The extreme example was one package where the variables had different
names
> and declarations from one program to another, the programmer concerned
wrote
> not one single comment in his code, and liked naming variables with
names
> like B320 B330 B340 etc. He was a superb programmer who believed code
> should be read to find what it does, and also liked reading object
files
> directly.....if you are lucky you wouldn't be maintaining his code, it
was
> hard to improve in all senses.
>
> John
>
>
> -----Original Message-----
> From: [EMAIL PROTECTED]
[mailto:[EMAIL PROTECTED]]
On
> Behalf Of Richard Vowles
> Sent: Friday, 5 May 2006 12:53 p.m.
> To: NZ Borland Developers Group - Delphi List
> Subject: RE: [DUG] Naming your code
>
>
> It should be in the version control check-in anyway so you know who to
> blame. The only reason it isn't in my code is I can't be bothered
putting
it
> there. It is there on templated code.
>
> (a dedicated subversion user).
>
> How about people change subject lines to match what we are talking
about.
> ---
> Richard Vowles, Solutions Architect, Borland New Zealand
> email: [EMAIL PROTECTED]
> phone: +64-9-9184573
> cell: +64-21-467747
> other: MSN [EMAIL PROTECTED] , skype: rvowles
> blog: http://www.usergroup.org.nz/blogs/selectBlog.html?id=39769
>
> -----Original Message-----
> From: [EMAIL PROTECTED]
[mailto:[EMAIL PROTECTED]]
> On Behalf Of Kyley Harris
> Sent: Thursday, 4 May 2006 11:42 p.m.
> To: NZ Borland Developers Group - Delphi List
> Subject: RE: [DUG] In case you're interested (or buy stuff)
>
> Correct. Many companies that rely on contractors to fulfill work do
not
want
> temp employess, etc to see a name, and go tell the competition who
they
> should contact for good design work. So in that case it is valid to
request
> unsigned work. If you really want to assert that you wrote something.
Get
a
> reference in writing on letterhead that cannot be disputed by future
> managers, employees etc. Get the letter to state unequivocally what
input
> you had such as design, implementation, delployment. NEVER rely on an
> interviewer calling someone. I make a point of providing no verbal
> references unless that person giving the ref would die for me, or
close :D
>
> _______________________________________________
> Delphi mailing list
> [email protected] http://ns3.123.co.nz/mailman/listinfo/delphi
>
>
> __________ NOD32 1.1461 (20060329) Information __________
>
> This message was checked by NOD32 antivirus system.
http://www.eset.com
>
>
>
> _______________________________________________
> Delphi mailing list
> [email protected]
> http://ns3.123.co.nz/mailman/listinfo/delphi
>
>
>
> --
> No virus found in this incoming message.
> Checked by AVG Free Edition.
> Version: 7.1.385 / Virus Database: 268.5.1/327 - Release Date:
28/04/2006
>
--
No virus found in this outgoing message.
Checked by AVG Free Edition.
Version: 7.1.385 / Virus Database: 268.5.1/327 - Release Date:
28/04/2006
_______________________________________________
Delphi mailing list
[email protected]
http://ns3.123.co.nz/mailman/listinfo/delphi
_______________________________________________
Delphi mailing list
[email protected]
http://ns3.123.co.nz/mailman/listinfo/delphi
_______________________________________________ Delphi mailing list [email protected] http://ns3.123.co.nz/mailman/listinfo/delphi
