Re: A forget-me-not to remind me to remember not to forget
by ww (Archbishop) on Nov 27, 2007 at 13:17 UTC
|
- POD
...and when I'm on good behavior, that means a fairly extensive pod, with caveats, gotchas, and usage examples, if the script has more than a very few options. (Sometimes I have the feeling that many script writers carry over their key-stroke saving practices, as used within a script, to the documentation, where such terseness can be a significant obstacle for the "future user.")
- a useage sub or block called when required arguments are not present or when user adds (any of) ?help, /h, /help, etc
- in line comments on any code I find "tricky"
...for which the maintenance programmer's or future user's mileage may vary
The last is sometimes disparaged, as "inelegant" or even "inept" but like your Cobol options, IMO such comments are worth enough (even for the current writer, 6 months later) to discount the disfavor they earn with some people, as not all prospective maintainers/users will know the meanings as you do.
| [reply] |
|
|
Indeed, ww. I retain enough of my assembly language background that I often keep up a running commentary alongside my code. I find that if I keep the hashmarks lined up, it doesn't detract from my ability to read just the code.
My desire to add these comments, some of which help and some of which are just a PITA distraction, does often conflict with coding standards that say that thou shalt line-wrap at 78. Then again, I don't often use camelCase, either... ;-]
For me, generally, the utility of the commentary outweighs the need to tidy it up every time I edit, because -- as in education -- if you can explain something well you understand it better. I find that switching back and forth from programming language to English language gives me time to consider what I'm doing. It's especially useful to go back and add comments with a cup of coffee after a late-night flow session where I've added a whole bunch of new code.
I'm still looking for the syntax highlighter or literate programming editor that'll let me selectively choose either just code, just comments, or both, but until I find it, I'll keep my left-right code and commentary style.
<DISCLAIMER>
Of course, I'm also the guy who says that two-finger typing helps me write better code because I have time to think between pecks... ;-D
</DISCLAIMER>
Don Wilde
"There's more than one level to any answer."
| [reply] |
Re: A forget-me-not to remind me to remember not to forget
by SkipHuffman (Monk) on Nov 29, 2007 at 19:47 UTC
|
The xcopy switches I always remember are /h /o /t /s /e /r /v. Lets see if I can remember all the meanings. er, /h hidden files also, /o overwrite destination, /t include system files, /s recurse into subdirectories, /e include empty directories, /r wait... maybe /r is recurse...then what is /s..., /v verify after write. I learned this on OS/2 we used this to basically image an entire drive instead of installing from thirty some odd diskettes.
| [reply] [d/l] |
|
|
| [reply] |
|
|
| [reply] [d/l] |
|
|
WinXP>xcopy /?
Copies files and directory trees.
XCOPY source [destination] [/A | /M] [/D[:date]] [/P] [/S [/E]] [/V] [
+/W]
[/C] [/I] [/Q] [/F] [/L] [/G] [/H] [/R] [/T
+] [/U]
[/K] [/N] [/O] [/X] [/Y] [/-Y] [/Z]
[/EXCLUDE:file1[+file2][+file3]...]
source Specifies the file(s) to copy.
destination Specifies the location and/or name of new files.
/A Copies only files with the archive attribute set,
doesn't change the attribute.
/M Copies only files with the archive attribute set,
turns off the archive attribute.
/D:m-d-y Copies files changed on or after the specified date.
If no date is given, copies only those files whose
source time is newer than the destination time.
/EXCLUDE:file1[+file2][+file3]...
Specifies a list of files containing strings. Each str
+ing
should be in a separate line in the files. When any of
+ the
strings match any part of the absolute path of the file
+ to be
copied, that file will be excluded from being copied.
+For
example, specifying a string like \obj\ or .obj will ex
+clude
all files underneath the directory obj or all files wit
+h the
.obj extension respectively.
/P Prompts you before creating each destination file.
/S Copies directories and subdirectories except empty ones
+.
/E Copies directories and subdirectories, including empty
+ones.
Same as /S /E. May be used to modify /T.
/V Verifies each new file.
/W Prompts you to press a key before copying.
/C Continues copying even if errors occur.
/I If destination does not exist and copying more than one
+ file,
assumes that destination must be a directory.
/Q Does not display file names while copying.
/F Displays full source and destination file names while c
+opying.
/L Displays files that would be copied.
/G Allows the copying of encrypted files to destination th
+at does
not support encryption.
/H Copies hidden and system files also.
/R Overwrites read-only files.
/T Creates directory structure, but does not copy files. D
+oes not
include empty directories or subdirectories. /T /E incl
+udes
empty directories and subdirectories.
/U Copies only files that already exist in destination.
/K Copies attributes. Normal Xcopy will reset read-only at
+tributes.
/N Copies using the generated short names.
/O Copies file ownership and ACL information.
/X Copies file audit settings (implies /O).
/Y Suppresses prompting to confirm you want to overwrite a
+n
existing destination file.
/-Y Causes prompting to confirm you want to overwrite an
existing destination file.
/Z Copies networked files in restartable mode.
The switch /Y may be preset in the COPYCMD environment variable.
This may be overridden with /-Y on the command line.
| [reply] [d/l] |
|
|
| [reply] [d/l] |
|
|
|
|