tlaComment
Apply Enterprise Standard Date/Time Stamp to Comment Line

Visual SlickEdit® - Slick-C Macro - Royalty Free - 2005.01.01 17:15
Send Comments

Purpose

Apply Enterprise Standard Date/Time Stamp to Comment Line.

Operation

This function stamps the current date/time into any comment statement that is of the form:

delimiter yyyy.mm.dd hh:mm when delimiter is set from an entry in a table keyed to the extension of the file.

This function calls tlaDateTime and as such will help implement your organization standard date/time stamp.

It is useful to have a "starter" date/time in the template that you use for module creation. If you use the supplied format emitted by tlaDateTime, an example of a "starter" date/time for C# might be:

// 2002.01.01 12:00      Copyright 1993-2005 ...

The document types (file extensions) currently supported by this function are:

Type Map Comment Revision Language
.adb   /*     Ada
.asm   ;     Assembly Language
.asp   <!-- ' TRUE Active Server Page
.awk   /*     Aho, Weinberger, and Weinberger
.bas   '     Basic
.bat   /*     Batch (Shell)
.c   //     C
.ctml   /*     CTML
.cls .bas '      
.cob   *     COBOL
.cpp   //     C++
.cs   //     C#
.ctl .bas '      
.cwb   '     AppBasic Macro (CodeWright)
.cxx   //     C++
.dob .bas '      
.dsr .bas '      
.e   //     Slick-C
.frm .bas '      
.h   //     Header (C)
.hpp   //     Header (C++)
.htm .html <!--   TRUE Hyper Text Markup Language
.html   <!--   TRUE Hyper Text Markup Language
.ini   '     Initialization
.hxx .hpp //     Header (C++)
.jav .java //     Java
.java   //     Java
.js   //     Jscript
.jsp   //     Java Server Page
.mac   //     API Macro (CodeWright)
.mak   #     Make and NMake
.nrx   /*     NetRexx
.pag bas '      
.pas   {     Pascal
.php   /*     PHP: Hypertext Preprocessor
.pl   # // TRUE Perl
.rc   /*     RC
.rul   /*     InstallScript
.sqlj   /*     SQLJ
.tcl   /*     Tcl/Tk
.tk   /*     Tcl/Tk
.txt   /*     Text
.v   /*     Verilog
.vb .bas '     Visual Basic
.vbs   '     VBscript
.vhd   /*     VHDL

Example

tlaComment( )

Return Codes

Count of replacements made in the file (zero if none were made).

Reference

This function calls tlaDateTime.

Compatibility

Current version verified under:

  • CodeWright 7.0b
  • CodeWright 7.0c
  • CodeWright 7.5.1
  • CodeWright 7.5.2
  • CodeWright for .NET 7.0

CodeWright for .NET Restriction

None.

Installation

There are three primary methods for installing this macro on your system. Method A uses the tlaMDE tool available for purchase from this website. Method B manipulates the macro repository directly. Method C uses the API Macro... tool provided in every copy of CodeWright (but not CodeWright for .NET).

Method A - tlaMDE - CodeWright or CodeWright for .NET

  • Select the Code button on this page.
  • When the second window opens, select all the text in the text box.
  • Issue Ctl-C (copy).
  • Create a new file in CodeWright or CodeWright for .NET.
  • Issue Ctl-V (paste).
  • Issue tlaMDE C (save and compile).

Method B - Copy to Repository - CodeWright or CodeWright for .NET

  • Select the Code button on this page.
  • When the second window opens, select all the text in the text box for a macro.
  • Issue Ctl-C (copy).
  • Load the macro repository "cwright.mac" from your CodeWright or CodeWright for .NET root:
  • issue Ctl-End to go to the end of file.
  • Issue Ctl-V (paste).
  • Close the file and respond yes to the write request.

Method C - API Macro ... - CodeWright Only

  • Select the Code button on this page.
  • When the second window opens, select text from the text box for a macro:
    • Do not select the [API Macro ... header line.
    • Select all other lines in the macro.
  • Issue Ctl-C (copy).
  • Open the CodeWright Tools | API Macros... dialog.
  • Press the New button.
  • Select the Edit box.
  • Issue Ctl-V (paste).
  • Double-click on the function name in the header of the macro.
  • Issue Ctl-C (copy).
  • Select the Name box.
  • Issue Ctl-V (paste).
  • Delete the trailing blank from the name.
  • Select the Save button.
  • Select the Close button.
  • Repeat this process for each macro in the text box.

Purchase

tlaSlick is a Dynamic Link Library that contains most of the API macros on this website in a single easy to install package. The tlaSlick DLL can be purchased by selecting the Buy button on this page.

tlaComment is included as a function in tlaSlick.

Copyright © 1993-2005 Thom Little Associates, Ltd. revised 2005.01.01 17:15
One Central Square, Keene, NH 03431-3787 phone 603-357-7567