Changes between Version 33 and Version 34 of CodeBestPractices

Timestamp:

2012-12-01 13:48:08 (11 years ago)

Author:

jeroens

Comment:

--

CodeBestPractices

@@ -10 +10 @@
    * [#Logging_events Logging events]
    * [#Assertions Checking for proper usage (Assertions)]
-   * Creation and disposal of objects and data
  * [#Compatibility Cross-platform compatibility]
    * [#Mono Mono]
-   * Target processor
+   * [#Target_processor] Target processor
  * [#User_Interface_design_guidelines User-interface design guidelines]
    * Re-use what's already there
@@ -85 +84 @@
 End Function
 }}}
+
+Note that we deliberately did not adopt the use of {http://msdn.microsoft.com/en-us/devlabs/dd491992.aspx CodeContracts] which make code a lot harder to read.
 ----
 == Compatibility ==
@@ -107 +108 @@
 || vbTab, etc || Convert.!ToChar(Keys.Tab), etc ||
 || vbNewline  || Environment.!NewLine ||
-|| !InStr, Left, Mid ||  .NET [http://msdn.microsoft.com/en-US/library/system.string_methods%28v=vs.80%29.aspx String class] ||
-|| MsgBox || See below, [#Notifications User Interface guidelines] ||
+|| !InStr, Left, Mid || [http://msdn.microsoft.com/en-US/library/system.string_methods%28v=vs.80%29.aspx .NET String class] ||
+|| !UBound, etc || [http://msdn.microsoft.com/en-us/library/system.array.getupperbound.aspx .NET Array class] ||
+|| !MsgBox || See below, [#Notifications User Interface guidelines] ||
 
 === Target processor ===
@@ -131 +133 @@
 == Notifications ==
 
+Instead of showing message boxes, in EwE we channel all user feedback through messages:
+ * [http://webservice.ecopath.org/Ecopath/Help/?topic=html/b372577d-dc80-8e05-e20a-63c033888fe7.htm Feedback messages] ask for user feedback, and
+ * [http://webservice.ecopath.org/Ecopath/Help/?topic=html/0002ea1e-d9d1-370c-0126-ff3cce98b16a.htm Regular messages] may pop up based on the message importance and alert preferences set by the user.
 
+Centralized messages have a few advantages:
+ * They will be written to the [#Logging_events EwE log];
+ * Are shown in the EwE status panel;
+ * Have the ability to be [http://webservice.ecopath.org/Ecopath/Help/?topic=html/7673c56d-88f7-1d4c-94ba-405a9092f252.htm suppressed].
 
 ----