Eiffel Code Comments - Revision history

Manus: /* Comment Mark Up */

2013-08-02T08:46:53Z

‎Comment Mark Up

Manus at 08:39, 2 August 2013

2013-08-02T08:39:47Z

Alexander Kogtenkov: Added a category

2011-06-16T17:33:07Z

Added a category

Peter gummer: /* Comment Mark Up */

2009-08-27T12:18:41Z

‎Comment Mark Up

Peter gummer at 12:15, 27 August 2009

2009-08-27T12:15:11Z

Paulb: Added mark up information

2009-08-26T19:13:42Z

Added mark up information

Paulb: /* Library Documentation Generation */

2009-08-26T17:54:47Z

‎Library Documentation Generation

Paulb at 18:06, 12 January 2009

2009-01-12T18:06:54Z

Paulb at 19:11, 21 April 2008

2008-04-21T19:11:25Z

Paulb at 19:10, 21 April 2008

2008-04-21T19:10:28Z

@@ Line 1: / Line 1: @@
 [[Category:Coding Standards]]
 ==Comment Mark Up ==
-The Eiffel compiler and EiffelStudio's code browsing tools support a special, light-weight mark up in comments and strings for referencing classes and features. EiffelStudio's code browsing tools utilize this mark up to better facilitate code navigation and browsing. In addition, marked up comments and strings will be examined and altered when performing a class or feature ''rename'' refactoring.
+The Eiffel compiler and EiffelStudio's code browsing tools support a special, light-weight mark up in comments and strings for referencing classes and features. EiffelStudio's code browsing tools use this mark up to better facilitate code navigation and browsing. In addition, marked up comments and strings will be examined and altered when performing a class or feature ''rename'' refactoring.
 ===Syntax===

← Older revision		Revision as of 08:39, 2 August 2013
Line 1:		Line 1:
−	~~[[Category:Coding Style Guidelines]]~~
	[[Category:Coding Standards]]		[[Category:Coding Standards]]
	==Comment Mark Up ==		==Comment Mark Up ==

@@ Line 1: / Line 1: @@
 [[Category:Coding Style Guidelines]]
 ==Comment Mark Up ==
 The Eiffel compiler and EiffelStudio's code browsing tools support a special, light-weight mark up in comments and strings for referencing classes and features. EiffelStudio's code browsing tools utilize this mark up to better facilitate code navigation and browsing. In addition, marked up comments and strings will be examined and altered when performing a class or feature ''rename'' refactoring.

@@ Line 1: / Line 1: @@
 [[Category:Coding Style Guidelines]]
 ==Comment Mark Up ==
-The Eiffel compiler and EiffelStudio's code browsing tools support a special, light-weight mark up in comments and strings for referencing classes and features. EiffelStudio's code browsing tools utilize this mark up to better facilitate code navigation and browsing. In addition, marked up comments and strings will be examined and altered when performing a class or feature _rename_ refactoring.
+The Eiffel compiler and EiffelStudio's code browsing tools support a special, light-weight mark up in comments and strings for referencing classes and features. EiffelStudio's code browsing tools utilize this mark up to better facilitate code navigation and browsing. In addition, marked up comments and strings will be examined and altered when performing a class or feature ''rename'' refactoring.
 ===Syntax===
@@ Line 18: / Line 18: @@
 </e>
-In the case where a reference to a feature is not accessible to the containing class directly, use a combination of the class reference mark up and a feature name, _sans_ quotation marks:
+In the case where a reference to a feature is not accessible to the containing class directly, use a combination of the class reference mark up and a feature name, ''sans'' quotation marks:
 <e>

@@ Line 1: / Line 1: @@
 [[Category:Coding Style Guidelines]]
 ==Comment Mark Up ==
-The Eiffel compiler and EiffelStudio's code browsing tools support a special, lite weight mark up in comments and string for referencing class and features. EiffelStudio's code browsing tools utilize this mark up to better facility code navigation and browsing. In addition, marked up comments and strings will be examined and altered when performing a class or feature rename refactor.
+The Eiffel compiler and EiffelStudio's code browsing tools support a special, light-weight mark up in comments and strings for referencing classes and features. EiffelStudio's code browsing tools utilize this mark up to better facilitate code navigation and browsing. In addition, marked up comments and strings will be examined and altered when performing a class or feature _rename_ refactoring.
 ===Syntax===
-The syntax for marking up classes and features is very compact, to ensure retained legibility. You'll see no need for XML or other types of verbose mark up found in other languages, which can impede comment's very nature of a quick reference.
+The syntax for marking up classes and features is very compact, to ensure retained legibility. You'll see no need for XML or other types of verbose mark up found in other languages, which can impede the comment's very nature as a quick reference.
-To mark up a class reference, surround the class name in and open ('''{''') and matching closing ('''}''') brace:
+To mark up a class reference, surround the class name in an open ('''{''') and matching closing ('''}''') brace:
 <e>
@@ Line 12: / Line 12: @@
 </e>
-To mark up a feature reference, implemented in the same class or parent, surround the feature name in and single back quote (`) and matching closing sing quote ('):
+To mark up a feature reference, implemented in the same class or parent, surround the feature name in a single back quote (`) and a matching closing single quote ('):
 <e>
@@ Line 18: / Line 18: @@
 </e>
-In the case where a reference to a feature no accessible to the containing class directly, a combination of the class reference mark up and a feature name, sans quotation marks:
+In the case where a reference to a feature is not accessible to the containing class directly, use a combination of the class reference mark up and a feature name, _sans_ quotation marks:
 <e>

← Older revision		Revision as of 19:13, 26 August 2009
Line 1:		Line 1:
	[[Category:Coding Style Guidelines]]		[[Category:Coding Style Guidelines]]
		+	==Comment Mark Up ==
		+	The Eiffel compiler and EiffelStudio's code browsing tools support a special, lite weight mark up in comments and string for referencing class and features. EiffelStudio's code browsing tools utilize this mark up to better facility code navigation and browsing. In addition, marked up comments and strings will be examined and altered when performing a class or feature rename refactor.
		+
		+	===Syntax===
		+	The syntax for marking up classes and features is very compact, to ensure retained legibility. You'll see no need for XML or other types of verbose mark up found in other languages, which can impede comment's very nature of a quick reference.
		+
		+	To mark up a class reference, surround the class name in and open ('''{''') and matching closing ('''}''') brace:
		+
		+	<e>
		+	-- See {DEBUG_OUTPUT} for more information.
		+	</e>
		+
		+	To mark up a feature reference, implemented in the same class or parent, surround the feature name in and single back quote (`) and matching closing sing quote ('):
		+
		+	<e>
		+	-- See `debug_output' for more information.
		+	</e>
		+
		+	In the case where a reference to a feature no accessible to the containing class directly, a combination of the class reference mark up and a feature name, sans quotation marks:
		+
		+	<e>
		+	-- See {DEBUG_OUTPUT}.debug_output for more information.
		+	</e>
		+
		+	The rules that apply for comments, as described above, can also be utilized in any manifest or verbatim string:
		+
		+	<e>
		+	note
		+	description: "Augments searching facilities of {STRING_8}"
		+	</e>
		+
	==Precursor Comments==		==Precursor Comments==

← Older revision		Revision as of 17:54, 26 August 2009
Line 108:		Line 108:

	=== Library Documentation Generation ===		=== Library Documentation Generation ===
−	Precursor comments are supported in all code browsing/documentation facilities, whether is be the integrated [[Contract Viewer]], the [[Feature Relation Tool]] or the Eiffel documentation generation facilities. Using <e>--Precursor</e> will ensure the comments are brought up from a parent declaration.	+	Precursor comments are supported in all code browsing/documentation facilities, whether is be the integrated [[Contract Viewer]], the [[Feature Relation Tool]] or the Eiffel documentation generation facilities. Using <e>-- <Precursor></e> will ensure the comments are brought up from a parent declaration.

← Older revision		Revision as of 18:06, 12 January 2009
Line 1:		Line 1:
		+	[[Category:Coding Style Guidelines]]
	==Precursor Comments==		==Precursor Comments==

@@ Line 1: / Line 1: @@
 {{Version|6.2}}
 Precursor comments declarations are a new mechanism added to EiffelStudio 6.2 to replicate a parent feature declaration's comments in the redefined/effective feature. The purpose of the mechanism is to reduce comment duplication, ease comment maintenance and facilitate augmentation.
@@ Line 104: / Line 105: @@
 -- Unable to retrieve the comments from redefinition of {CLASS_NAME}.
 </e>
 === Library Documentation Generation ===
 Precursor comments are supported in all code browsing/documentation facilities, whether is be the integrated [[Contract Viewer]], the [[Feature Relation Tool]] or the Eiffel documentation generation facilities. Using <e>--Precursor</e> will ensure the comments are brought up from a parent declaration.

← Older revision		Revision as of 19:10, 21 April 2008
Line 1:		Line 1:
−	~~{{UnderConstruction}}~~
−
	{{Version\|6.2}}		{{Version\|6.2}}