3 Letter Filename Extension for Batch Documentation?

Discussion forum for all Windows batch related topics.

Moderator: DosItHelp

Post Reply
Message
Author
Clueless in Seattle
Posts: 47
Joined: 01 Jul 2011 13:37

3 Letter Filename Extension for Batch Documentation?

#1 Post by Clueless in Seattle » 25 Mar 2013 08:06

Back in the day, it seemed to be common practice to tag text files containing program documentation with the three letter extension ".DOC"

But when Microsoft Word came onto the scene, it co-opted that extension to designate files in its own word processing format.

I'm a batch file addict, and often write long complicated batch files that when I look back at them later, I can't figure out what in the heck they are supposed to do or how they are supposed to do it. (Yes, I'm getting old and my memory is failing, I won't deny that).

So I now clutter up my batch files with REM comment lines that often take up far more space that the batch code itself.

So, I'm thinking of writing plain text documentation files that explain how some of these inscrutable batch files work. But since the ".doc" extension was long ago taken over by Microsoft, I'm casting about for a replacement.

The first one that comes to mind, of course, is "REM." But I just Googled it and found that Blackberry has already taken it to designate its encrypted files.

So, I'd be grateful for your suggestions,

Will in Seattle
a.k.a. "Clueless"

foxidrive
Expert
Posts: 6031
Joined: 10 Feb 2012 02:20

Re: 3 Letter Filename Extension for Batch Documentation?

#2 Post by foxidrive » 25 Mar 2013 08:24

*.TXT is a format for plain text files. You can also use *.DOC as Word/Notepad/Wordpad will still open plain text files with that extension AFAIK.

I'd continue to use REMs inside the batch file itself, which makes it easy to see the code and the description at the same time. Easier than having two files open, in the long term.

Squashman
Expert
Posts: 4488
Joined: 23 Dec 2011 13:59

Re: 3 Letter Filename Extension for Batch Documentation?

#3 Post by Squashman » 25 Mar 2013 09:57

TXT has been the extension I have used since the 80's if it was just a plain old text file.
Other files are plain text files but use other extensions to identify what software language it is programmed in or what software uses that extension. All my old Pascal code was saved as PAS before I compiled it.

Ocalabob
Posts: 79
Joined: 24 Dec 2010 12:16
Location: Micanopy Florida

Re: 3 Letter Filename Extension for Batch Documentation?

#4 Post by Ocalabob » 25 Mar 2013 19:06

Greetings Will,
Why not just make up your own file extension for your documentation if it is destined for your own use?

Example:
"long complicated batch.bat"
"long complicated batch.wil" or even better
"long complicated batch.will"

Double click the documentation file, find your favorite text editor, check the box for "always use" and "bob's your uncle"!

Best wishes Will!

Post Reply