Namespace: Consultingwerk.Studio.Refactor.CommentStyle
Class 
CommentFormatter Copy to Clipboard
Parent classes:
Inherits: Progress.Lang.Object

File:CommentFormatter
Purpose:Formats comments according to the OEDT style and
replaces tabs with spaces
Author(s):Robert Chelaru / Consultingwerk Ltd.
Created:Mon Jul 06 11:11:11 EEST 2020



Top Method Summary
Options Name Purpose
FormatComments (character) Overwrites a formatted version of the file by the OEDT comment standards and replaces tabs with the number of spaces set by SpacesForTabs.
FormatComments (character, character) Creates a formatted version of the file, at the specified target path, by the OEDT comment standards and replaces tabs with the number of spaces set by iTabSpaces.
LOGICAL TestNonCommentCharacter (character) Tests if the current line does (also) contain characters that are ont expected in the PDSOE style first or last line of a comment

Top Property Summary
Options Name Purpose
INTEGER SpacesForTabs


Method Detail
Top

FormatComments (character)

Purpose: Overwrites a formatted version of the file by the
OEDT comment standards and replaces tabs with the number of spaces
set by SpacesForTabs.
Notes: Must specify the file name and extension.

Parameters:
pcFilePath CHARACTER
The source filepath
Top

FormatComments (character, character)

Purpose: Creates a formatted version of the file, at the specified
target path, by the OEDT comment standards and replaces
tabs with the number of spaces set by iTabSpaces.
Notes: Must specify the file name and extension.

Parameters:
pcFilePath CHARACTER
The source filepath
pcOutputFilePath CHARACTER
The output target for creation
Top

LOGICAL TestNonCommentCharacter (character)

Purpose: Tests if the current line does (also) contain characters that are
ont expected in the PDSOE style first or last line of a comment
Notes:

Parameters:
pcLine CHARACTER
The line to test
Returns LOGICAL
Logical value indicating if the line contains also non comment characters


Property Detail
Top

INTEGER SpacesForTabs


Returns INTEGER


©2006-2026 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       13.04.2026 10:30:05