mirrors/eiffel-org
1
0
Fork 0
mirror of https://github.com/EiffelSoftware/eiffel-org.git synced 2025-12-07 07:12:25 +01:00
Code Issues Packages Projects Releases Wiki Activity

Updated wikipage Eiffel Code Comments. (Signed-off-by:roc_admin).

Browse Source 
git-svn-id: https://svn.eiffel.com/eiffel-org/trunk@2479 abb3cda0-5349-4a8f-a601-0c33ac3a8c38
This commit is contained in:
eiffel-org
2024-06-27 10:45:27 +00:00
parent 24c454d005
commit 48f9db190e
1 changed files with 4 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
documentation/24.05/eiffel/Coding_Standards/Eiffel-Code-Comments.wiki
View File

@@ -1,4 +1,4 @@
[[Property:modification_date|Mon, 13 Dec 2021 12:42:51 GMT]] [[Property:modification_date|Thu, 27 Jun 2024 10:45:27 GMT]]
[[Property:publication_date|Thu, 03 Jan 2019 18:00:43 GMT]] [[Property:publication_date|Thu, 03 Jan 2019 18:00:43 GMT]]
[[Property:uuid|146E241E-C367-4F16-9CCE-6F11E5F7860A]] [[Property:uuid|146E241E-C367-4F16-9CCE-6F11E5F7860A]]
[[Property:weight|1]] [[Property:weight|1]]
@@ -145,11 +145,12 @@ f (a_arg: INTEGER): BOOLEAN
This will have exactly the same effect as using <e>-- <Precursor></e> when <e>f</e> is made effective/redefined from a single parent. However, when making effective/redefining from multiple parents, then comments will come from the parent class declaration in <e>BASE</e>. This will have exactly the same effect as using <e>-- <Precursor></e> when <e>f</e> is made effective/redefined from a single parent. However, when making effective/redefining from multiple parents, then comments will come from the parent class declaration in <e>BASE</e>.
Again, because precursor comments do not affect compilation, they are not checked at compile time. Specifying an incorrect class will yield a warning message in [[EiffelStudio]]'s code browsing tools, to the effect: Again, because precursor comments do not affect compilation, they are not checked at compile time. Specifying an incorrect class will yield a warning message in [/doc/eiffelstudio/EiffelStudio EiffelStudio]'s code browsing tools, to the effect:
<e> <e>
-- Unable to retrieve the comments from redefinition of {CLASS_NAME}. -- Unable to retrieve the comments from redefinition of {CLASS_NAME}.
</e> </e>
=== Library Documentation Generation === === Library Documentation Generation ===
Precursor comments are supported in all code browsing/documentation facilities, whether it 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 it be the integrated [/doc/eiffelstudio/Contract_Editor_tool Contract Viewer
], the [https://www.eiffel.org/doc/eiffelstudio/Feature_views Feature Relation Tool] or the Eiffel documentation generation facilities. Using <e>-- <Precursor></e> will ensure the comments are brought up from a parent declaration.