Local Declaration Guidelines - Revision history

Manus at 08:41, 2 August 2013

2013-08-02T08:41:07Z

Alexander Kogtenkov: /* Object Tests */ Used current syntax of object tests.

2013-08-02T05:52:21Z

‎Object Tests: Used current syntax of object tests.

Paulb: /* Other Well-Known Names */

2009-03-09T18:19:45Z

‎Other Well-Known Names

Paulb: /* In-line Agents */

2009-03-09T18:18:37Z

‎In-line Agents

Paulb at 18:50, 12 January 2009

2009-01-12T18:50:50Z

Paulb: /* Well Known Variable Names */

2009-01-12T18:49:27Z

‎Well Known Variable Names

Paulb: /* In In-line Agent */

2009-01-12T18:43:56Z

‎In In-line Agent

Paulb: /* Indexing Variable Names */

2009-01-12T18:43:41Z

‎Indexing Variable Names

Paulb: /* Feature Arguments */

2009-01-12T18:32:42Z

‎Feature Arguments

Paulb: d

2009-01-12T18:31:51Z

← Older revision		Revision as of 08:41, 2 August 2013
Line 1:		Line 1:
−	[[Category:Coding ~~Style Guidelines~~]]	+	[[Category:Coding Standards]]

	Local declaration style guidelines for contributing to the Eiffel Software code repository.		Local declaration style guidelines for contributing to the Eiffel Software code repository.

@@ Line 148: / Line 148: @@
 === Object Tests ===
-Object test locals obey the same rules and other standard local declarations, that it, prefixing a variable moniker with ''</e>l_</e>''. However, due to the current scoping rules of object-tests, where no object test local may be reused, extraneous guidelines need to be defined.
+Object test locals obey the same rules and other standard local declarations, that it, prefixing a variable moniker with ''<e>l_</e>''. However, due to the current scoping rules of object-tests, where no object test local may be reused, extraneous guidelines need to be defined.
 <e>
@@ Line 154: / Line 154: @@
          -- An example using object-test scoped local variable names.
      do
-         if {l_disposable: DISPOSABLE_I} Current then
+         if attached {DISPOSABLE_I} Current as l_disposable then
              l_disposable.dispose
          end
@@ Line 173: / Line 173: @@
          -- An example using object-test scoped local variable names in contracts.
      require
-         is_interface_usable: {rl_usable: USABLE_I} Current implies rl_usable.is_interface_usable
+         is_interface_usable: attached {USABLE_I} Current as rl_usable implies rl_usable.is_interface_usable
      do
          ...
      ensure
-         not_is_interface_usable: {el_usable: USABLE_I} Current implies not el_usable.is_interface_usable
+         not_is_interface_usable: attached {USABLE_I} Current as el_usable implies not el_usable.is_interface_usable
      end
 </e>

@@ Line 126: / Line 126: @@
 * ''<e>uc</e>'' for a Unicode character.
 * ''<e>us</e>'' for a Unicode string (descendant of READABLE_STRING_32).
 ==== Rescue Clauses ====

@@ Line 186: / Line 186: @@
 <e>
-l_action := agent (a_string: READABLE_STRING_GENERAL)
+l_action := agent (ia_string: READABLE_STRING_GENERAL)
      local
          il_i, il_count: INTEGER

@@ Line 122: / Line 122: @@
 * ''<e>c</e>'' for any type of character.
-* ''<e>e</e>'' for any type of exception (descendent of EXCEPTION).
+* ''<e>e</e>'' for any type of exception (descendant of EXCEPTION).
-* ''<e>s</e>'' for any type of string (descendent of READABLE_STRING_GENERAL).
+* ''<e>s</e>'' for any type of string (descendant of READABLE_STRING_GENERAL).
 * ''<e>uc</e>'' for a Unicode character.
-* ''<e>us</e>'' for a Unicode string (descendent of READABLE_STRING_32).
+* ''<e>us</e>'' for a Unicode string (descendant of READABLE_STRING_32).
 ==== Rescue Clauses ====

@@ Line 172: / Line 172: @@
 No prefix, other than ''<e>l_</e>'' is needed for class invariants because no conflicts in variable name reuse exist in an invariant scope.
-=== In In-line Agent ===
+=== In-line Agents ===
 There is no real preferred convention for local declaration inside in-line agents and the ''<e>l_</e>'' prefix should be used if possible. However, for clarity this cannot always be such the case. When such as scenario arises the use of ''<e>il_</e>'' (in-line local) is preferred. It is recommended that all locals utilize the same prefix and '''not''' mix ''<e>l_</e>'' and <e>il_</e>''!

← Older revision		Revision as of 18:43, 12 January 2009
Line 171:		Line 171:

	No prefix, other than ''<e>l_</e>'' is needed for class invariants because no conflicts in variable name reuse exist in an invariant scope.		No prefix, other than ''<e>l_</e>'' is needed for class invariants because no conflicts in variable name reuse exist in an invariant scope.
		+
		+	=== In In-line Agent ===
		+	There is no real preferred convention for local declaration inside in-line agents and the ''<e>l_</e>'' prefix should be used if possible. However, for clarity this cannot always be such the case. When such as scenario arises the use of ''<e>il_</e>'' (in-line local) is preferred. It is recommended that all locals utilize the same prefix and '''not''' mix ''<e>l_</e>'' and <e>il_</e>''!
		+
		+	<e>
		+	l_action := agent (a_string: READABLE_STRING_GENERAL)
		+	local
		+	il_i, il_count: INTEGER
		+	do
		+	....
		+	end
		+	</e>
		+
		+	Notice that even well-known local declaration names are prefixed, this is to avoid conflicts with the containing routine or in-line agent as well as providing consistency in the naming of local variables.
		+
		+	With nested in-line agents use the same name index injection guideline, placing the nested index after the initial ''<e>i</e>'' prefix. For a second level in-line agent, this would be ''<e>i2l_</e>''.

	== Indexing Variable Names ==		== Indexing Variable Names ==

@@ Line 4: / Line 4: @@
 == Feature Arguments ==
-Feature arguments should begin with the prefix <e>a_</e> and nothing more. The prefix <e>a_</e> represent a contraction of the word ''argument'' and does not represent the singular inflection - a ''noun'' - Therefore it is '''not''' valid to utilize ''an'' when the suffixed argument word begins with a vowel. The following is a correct usage:
+Feature arguments should begin with the prefix ''<e>a_</e>'' and nothing more. The prefix ''<e>a_</e>'' represent a contraction of the word ''argument'' and does not represent the singular inflection - a ''noun'' - Therefore it is '''not''' valid to utilize ''an'' when the suffixed argument word begins with a vowel. The following is a correct usage:
 <e>
@@ Line 13: / Line 13: @@
 </e>
-Here, the second argument <e>a_integer</e>, is not considered ''A Integer'' but ''The Argument Integer'', hence the use if <e>a_</e> instead of <e>_an_</e>.
+Here, the second argument ''<e>a_integer</e>'', is not considered ''A Integer'' but ''The Argument Integer'', hence the use if <e>a_</e> instead of ''<e>_an_</e>''.
 === In-line Agent Routine Arguments ===
@@ Line 44: / Line 55: @@
                      end (ia_string.as_lower, ia_integer)
              end (a_string, a_integer))
      end
 </e>