Comment Doc

Extract comments from your script

Description

Extracts comments from specially formatted files.

Version

1.0

Last Mod

October 2009

Client

NA

Language

VbScript

Finish Level

Application

Description

Scans through selected file, extracting text lines between delimiters, as a means of documenting a script’s content. The lines containing the delimiters are replaced in the output with solid lines. Script content between delimiters is extracted to the output file.

Configuration

No configuration for running the script. Prepare the target file, presumably a script file by bracketing comments with opening and closing delimiters. The path/name of the log file and the delimiter strings are configured within the script body around line 35. Default delimiter strings are:

      Open ’’\

      Close ’’/

These are typically at the end of "break lines" of repetitive characters.

      ’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’\

      ’Comment line 1

      ’Comment line 2

      ’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’/

Subroutine declarations are typically included in a comment block.

      ’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’\

      Function Foo( Parm1, Parm2 )

      ’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’

      ’Comment line

      ’Comment line 2

      ’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’’/

Execution

Place the script, or the EXE version, in the system’s path. Syntax:

      CommentDoc /File:TargetFileName

          Note – Do not leave a space between the colon and the file name.

Documentation

Just this

Download

Home Up