From 4797d5df6134433fa29e7674ecf4a3deadda6473 Mon Sep 17 00:00:00 2001 From: eiffel-org Date: Fri, 4 Jan 2019 15:06:27 +0000 Subject: [PATCH] Updated wikipage Eiffel Code Comments. (Signed-off-by:bmeyer). git-svn-id: https://svn.eiffel.com/eiffel-org/trunk@2127 abb3cda0-5349-4a8f-a601-0c33ac3a8c38 --- .../eiffel/Coding_Standards/Eiffel-Code-Comments.wiki | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/documentation/18.11/eiffel/Coding_Standards/Eiffel-Code-Comments.wiki b/documentation/18.11/eiffel/Coding_Standards/Eiffel-Code-Comments.wiki index 930cd053..7d8d85b0 100644 --- a/documentation/18.11/eiffel/Coding_Standards/Eiffel-Code-Comments.wiki +++ b/documentation/18.11/eiffel/Coding_Standards/Eiffel-Code-Comments.wiki @@ -1,4 +1,4 @@ -[[Property:modification_date|Thu, 03 Jan 2019 18:00:43 GMT]] +[[Property:modification_date|Fri, 04 Jan 2019 15:06:26 GMT]] [[Property:publication_date|Thu, 03 Jan 2019 18:00:43 GMT]] [[Property:uuid|146E241E-C367-4F16-9CCE-6F11E5F7860A]] [[Property:weight|1]] @@ -16,18 +16,20 @@ To mark up a class reference, surround the class name in an open (` { `) and mat -- See {DEBUG_OUTPUT} for more information. -To mark up a feature reference, implemented in the same class or parent, surround the name with two single back quotes (`` `...` ``), or in a single back quote and a matching closing single quote (`` `...' ``): +To mark up a feature reference, implemented in the same class or parent, surround the name with two single back quotes (`` `...` ``): -- See `debug_output` for more information. -or +The earlier convention, which you will still find in much existing code, used a single back quote for opening and a matching normal quote for closing, as in -- See `debug_output' for more information. +The new convention, with back quotes both for opening and for closing, is the recommended one. + 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: