Changes between Version 21 and Version 22 of CodeBestPractices

Timestamp:

2012-12-01 11:02:37 (11 years ago)

Author:

jeroens

Comment:

--

CodeBestPractices

@@ -4 +4 @@
 The following issues are discussed on this page:
  * [#Robustness Robustness]
-   * [#try_/_cath Try / Catch and Assertions]
+   * [#try_/_cath Try / Catch]
+   * Logging errors
    * Creation and disposal of objects and data
-   * Logging events
  * [#Compatibility Cross-platform compatibility]
    * [#Mono Mono]
@@ -30 +30 @@
             Handles m_btnRun.Click
 
-            Try
+            '''Try'''
                 If Not Me.IsRunning Then
                     Me.m_iTimeSteps = Me.Core.nEcosimTimeSteps
@@ -36 +36 @@
                     Me.Core.RunEcoSim(AddressOf TimeStepFromEcoSim_handler, True)
                 End If
-            Catch ex As Exception
+            '''Catch ex As Exception'''
                 cLog.Write(ex, "form RunEcosim.OnRun")
-            End Try
+            '''End Try'''
 
         End Sub
@@ -47 +47 @@
 === Logging events ===
 
-The EwE Log file, created and managed by the core, and stored in the Windows application data folder, contains a track list of important actions taken by !EwE in response to user requests and a track record of failures and successes. The purpose of the log is to provide postmortem diagnostics when an error has occurred. You can use the log as well in your plug-ins. Frankly, we think you should, because 
+The EwE Log file, created and managed by the core, and stored in the Windows application data folder, contains a track list of important actions taken by EwE in response to user requests and a track record of failures and successes. The purpose of the log is to provide postmortem diagnostics when an error has occurred. You can use the log as well in your plug-ins. Frankly, we think you should.
+
+If you strategically encapsulate [#try_/_cath Try / Catch] blocks, why not write the result of the exception to the log file:
+
+Take for instance the code that runs in response to a 'Run' button click on the Run Ecosim form:
+{{{
+        Private Sub OnRun(ByVal sender As System.Object, ByVal e As System.EventArgs) _
+            Handles m_btnRun.Click
+
+            Try
+                If Not Me.IsRunning Then
+                    Me.m_iTimeSteps = Me.Core.nEcosimTimeSteps
+                    Me.m_graph.Refresh()
+                    Me.Core.RunEcoSim(AddressOf TimeStepFromEcoSim_handler, True)
+                End If
+            Catch ex As Exception
+                '''cLog.Write(ex, "form RunEcosim.OnRun")'''
+            End Try
+
+        End Sub
+}}}
 ----