Coding guideline - Common rules - Revision history

Wikicatglobe at 04:39, 18 October 2013

2013-10-18T04:39:58Z

← Older revision		Revision as of 04:39, 18 October 2013
Line 1:		Line 1:
	<accesscontrol>~~Administrators,,Cem,,Maysunshine~~</accesscontrol>		<accesscontrol>Main:MyGroup</accesscontrol>
	== Introduction ==		== Introduction ==

Cg_pham at 09:27, 4 October 2011

2011-10-04T09:27:28Z

← Older revision		Revision as of 09:27, 4 October 2011
Line 1:		Line 1:
			<accesscontrol>Administrators,,Cem,,Maysunshine</accesscontrol>
	== Introduction ==		== Introduction ==

Catglobe: Undo revision 1032 by Chinh (Talk)

2008-12-23T02:24:55Z

Undo revision 1032 by Chinh (Talk)

Show changes

Catglobe: Undo revision 1033 by Chinh (Talk)

2008-12-23T02:24:42Z

Undo revision 1033 by Chinh (Talk)

Show changes

Catglobe: Undo revision 1034 by Chinh (Talk)

2008-12-23T02:24:26Z

Undo revision 1034 by Chinh (Talk)

Show changes

Catglobe: Undo revision 1035 by Chinh (Talk)

2008-12-23T02:24:11Z

Undo revision 1035 by Chinh (Talk)

← Older revision		Revision as of 02:24, 23 December 2008
Line 900:		Line 900:
	==== Direct cast vs. <font face="Courier New, monospace" size="2" color="#0000ff" style="font-size: 9pt;">as</font> keyword ====		==== Direct cast vs. <font face="Courier New, monospace" size="2" color="#0000ff" style="font-size: 9pt;">as</font> keyword ====

	Following code block:		Following code block: <font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"></font>
	<~~source lang~~="~~csharp~~">
	CustomClass a = src as CustomClass;		:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#2b91af">CustomClass</font> a = src <font color="#0000ff">as </font><font color="#2b91af">CustomClass</font>;</font>
	</~~source~~>
			<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"></font>

	can be considered the same as the code block below: <font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"></font>		can be considered the same as the code block below: <font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"></font>
	~~<source lang="csharp">~~
	~~if (src is CustomClass)~~
	~~return (CustomClass)src;~~
	~~else~~
	~~return null;~~
	~~</source>~~

	Consequently, it is encouraged to use <font face="Courier New, monospace" size="2" color="#0000ff" style="font-size: 9pt;">as</font> keyword over directcasting, because it is neat and safer.		:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#0000ff">if </font>(src <font color="#0000ff">is</font> <font color="#2b91af">CustomClass</font>) </font>
			::<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#0000ff">return </font>(<font color="#2b91af">CustomClass</font>)src;</font>
			:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">else </font>
			::<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#0000ff">return </font><font color="#0000ff">null</font>;</font>

			<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"></font>

			Consequently, it is encouraged to use <font face="Courier New, monospace" size="2" color="#0000ff" style="font-size: 9pt;">as</font> keyword over directcasting, because it is neat and safer.

	=== Exceptions handling ===		=== Exceptions handling ===

Catglobe: Undo revision 1036 by Chinh (Talk)

2008-12-23T02:23:56Z

Undo revision 1036 by Chinh (Talk)

← Older revision		Revision as of 02:23, 23 December 2008
Line 880:		Line 880:
	*Never hardcoded strings that will be presented to end-users. Use <font face="Courier New, monospace" size="2" color="#33a3a3" style="font-size: 9pt;">Resoures</font> class instead.		*Never hardcoded strings that will be presented to end-users. Use <font face="Courier New, monospace" size="2" color="#33a3a3" style="font-size: 9pt;">Resoures</font> class instead.

	''<u>Must not</u>'':		''<u>Must not</u>'': <font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"></font>
	<~~source lang~~="~~xml~~">
	~~<span>Username</span>~~
	</~~source~~>

	''<u>Must</u>'':		:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#0000ff"><</font><font color="#a31515">span</font><font color="#0000ff">></font>Username<font color="#0000ff"></</font><font color="#a31515">span</font><font color="#0000ff">></font></font>
	<~~source lang~~="~~xml~~">
	<span><%=Resources.Username %></span>		<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"></font>
	</~~source~~>
			''<u>Must</u>'': <font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"></font>

			:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#0000ff"><</font><font color="#a31515">span</font><font color="#0000ff">></font><%<font color="#0000ff">=</font>Resources.Username %><font color="#0000ff"></</font><font color="#a31515">span</font><font color="#0000ff">></font></font>

			<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"></font>

	*Try to use @ instead escape characters symbol		*Try to use @ instead escape characters symbol

	''<u>Should:</u>''		''<u>Should:</u>''
	<~~source lang~~="~~csharp~~">
	string filename = @"D:\test\test.xml";		:<font color="#0000ff">string </font>filename = <font color="#a31515">@"D:\test\test.xml"</font>;
	</~~source~~>

	==== Direct cast vs. <font face="Courier New, monospace" size="2" color="#0000ff" style="font-size: 9pt;">as</font> keyword ====		==== Direct cast vs. <font face="Courier New, monospace" size="2" color="#0000ff" style="font-size: 9pt;">as</font> keyword ====

Catglobe: Undo revision 1037 by Chinh (Talk)

2008-12-23T02:23:44Z

Undo revision 1037 by Chinh (Talk)

← Older revision		Revision as of 02:23, 23 December 2008
Line 833:		Line 833:
	*If possible, initialize variables at declaration time.		*If possible, initialize variables at declaration time.

	''<u>Should:</u>''		''<u>Should:</u>'' <font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"></font>
	<~~source lang~~="~~csharp~~">
	private int primaryId = 0;		:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#0000ff">private </font><font color="#0000ff">int </font>primaryId = 0;</font>
	private string sampleString = string.Empty;		:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#0000ff">private </font><font color="#0000ff">string </font>sampleString = <font color="#0000ff">string</font>.Empty;</font>
	private List<int> sampleList = new List<int>();		:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#0000ff">private </font><font color="#2b91af">List</font><<font color="#0000ff">int</font>> sampleList = <font color="#0000ff">new</font> <font color="#2b91af">List</font><<font color="#0000ff">int</font>>();</font>
	</~~source~~>
			<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"></font>

	*Must use fully qualified name of types, declare the type by using statements. In case there are duplication in type's name, define aliases.		*Must use fully qualified name of types, declare the type by using statements. In case there are duplication in type's name, define aliases.

	''<u>Must not:</u>''		''<u>Must not:</u>'' <font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"></font>
	<~~source lang~~="~~csharp~~">
	ResourceCollectionPager pager = CatGlobe.Framework.Services.SessionManager.Current.DataModule.Get<ResourceCollectionPager>(Request["sessionid"]);		:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#2b91af">ResourceCollectionPager</font> pager = CatGlobe.Framework.Services.<font color="#2b91af">SessionManager</font>.Current.DataModule.Get<<font color="#2b91af">ResourceCollectionPager</font>>(Request[<font color="#a31515">"sessionid"</font>]);</font>
	</~~source~~>
			<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"></font>

	''<u>Must:</u>''		''<u>Must:</u>'' <font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"></font>
	<~~source lang~~="~~csharp~~">
	~~using CatGlobe.Framework.Services;~~
	~~ResourceCollectionPager pager~~ = ~~SessionManager.Current.DataModule.Get<ResourceCollectionPager>(Request[~~"~~sessionid~~"]);
	</~~source~~>

			:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#0000ff">using</font> CatGlobe.Framework.Services;</font>
			:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#2b91af">ResourceCollectionPager</font> pager = <font color="#2b91af">SessionManager</font>.Current.DataModule.Get<<font color="#2b91af">ResourceCollectionPager</font>>(Request[<font color="#a31515">"sessionid"</font>]);</font>

			<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"></font>
	<div style="border: 1pt solid rgb(0, 0, 0); padding: 5px; background: rgb(192, 192, 192) none repeat scroll 0% 0%; -moz-background-clip: -moz-initial; -moz-background-origin: -moz-initial; -moz-background-inline-policy: -moz-initial; color: rgb(0, 0, 255);">		<div style="border: 1pt solid rgb(0, 0, 0); padding: 5px; background: rgb(192, 192, 192) none repeat scroll 0% 0%; -moz-background-clip: -moz-initial; -moz-background-origin: -moz-initial; -moz-background-inline-policy: -moz-initial; color: rgb(0, 0, 255);">
	'''Tips:''' <br> Always choose “using” over fully qualified name from Resolve menu of Visual Studio. [[Image:Coding Guidelines Common rules 1.0 html m6738e672.png\|center\|400px\|Resolve menu of VS2008]]		'''Tips:''' <br> Always choose “using” over fully qualified name from Resolve menu of Visual Studio. [[Image:Coding Guidelines Common rules 1.0 html m6738e672.png\|center\|400px\|Resolve menu of VS2008]]
	</div>		</div>
	''<u>Example of using alias:</u>''		''<u>Example of using alias:</u>'' <font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"></font>
	<~~source lang~~="~~csharp~~">
	using Threading = System.Threading;		:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#0000ff">using </font>Threading = System.Threading;</font>
	using Timers = System.Timers;		:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#0000ff">using </font>Timers = System.Timers;</font>
	using Web = System.Web.UI;		:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#0000ff">using </font>Web = System.Web.UI;</font>

			:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#0000ff">namespace</font>CatGlobe.DataAccess</font>
			:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">{ </font>
			::<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#0000ff">public </font><font color="#0000ff">class </font><font color="#2b91af">SampleClass</font></font>
			::<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">{ </font>
			:::<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#0000ff">private </font>Threading.<font color="#2b91af">Timer</font> _threadTimer1;</font>
			:::<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#0000ff">private </font>Timers.<font color="#2b91af">Timer</font> _threadTimer2;</font>
			:::<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#0000ff">private </font>Web.<font color="#2b91af">Timer</font> _threadTimer3;</font>
			::<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">}</font>
			:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">}</font>

	~~namespaceCatGlobe.DataAccess~~		<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"></font>
	{
	~~public class SampleClass~~
	{
	~~private Threading.Timer _threadTimer1;~~
	~~private Timers.Timer _threadTimer2;~~
	~~private Web.Timer _threadTimer3~~;
	}
	}
	</~~source~~>

	==== Constants and Literals ====		==== Constants and Literals ====

Catglobe: Undo revision 1038 by Chinh (Talk)

2008-12-23T02:23:32Z

Undo revision 1038 by Chinh (Talk)

← Older revision		Revision as of 02:23, 23 December 2008
Line 817:		Line 817:
	*All access modifier must be explicitly given, except in interface's declaration where <font color="#0000ff"><font face="Courier New, monospace">public</font></font> is undertood by default.		*All access modifier must be explicitly given, except in interface's declaration where <font color="#0000ff"><font face="Courier New, monospace">public</font></font> is undertood by default.

	''<u>Must not:</u>''		''<u>Must not:</u>'' <font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"></font>
	<~~source lang~~="~~csharp~~">
	class SampleClass		:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#0000ff">class </font><font color="#2b91af">SampleClass</font></font>
	{		:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">{ </font>
	int sampleInt;		::<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#0000ff">int </font>sampleInt;</font>
	void SampleMethod()		::<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#0000ff">void </font>SampleMethod()</font>
	{		::<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">{</font>
	}		::<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">}</font>
	}		:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">}</font>
	</~~source~~>
			<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"></font>

	==== Variables and Types ====		==== Variables and Types ====

Catglobe: Undo revision 1039 by Chinh (Talk)

2008-12-23T02:23:16Z

Undo revision 1039 by Chinh (Talk)

← Older revision		Revision as of 02:23, 23 December 2008
Line 793:		Line 793:
	*For elements that have more than one Attribute declaration, then each <font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">Attribute</font> must be put on one line.		*For elements that have more than one Attribute declaration, then each <font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">Attribute</font> must be put on one line.

	''<u>Must not:</u>''		''<u>Must not:</u>'' <font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"></font>
	<~~source lang~~="~~csharp~~">
	~~[Serializable, STAThread, Obsolete(~~"~~This class is obsolete. Use class Abc instead.~~")]
	~~public class SampleClass~~
	</~~source~~>

	''<u>Must:</u>''		:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">[<font color="#2b91af">Serializable</font>, <font color="#2b91af">STAThread</font>, <font color="#2b91af">Obsolete</font>(<font color="#a31515">"This class is obsolete. Use class Abc instead."</font>)]</font>
	<~~source lang~~="~~csharp~~">		:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#0000ff">public </font><font color="#0000ff">class </font><font color="#2b91af">SampleClass</font></font>
	[Serializable]
	[STAThread]		<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"></font>
	[Obsolete("This class is obsolete. Use class Abc instead.")]
	public class SampleClass		''<u>Must:</u>'' <font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"></font>
	</~~source~~>
			:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">[<font color="#2b91af">Serializable</font>]</font>
			:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">[<font color="#2b91af">STAThread</font>]</font>
			:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">[<font color="#2b91af">Obsolete</font>(<font color="#a31515">"This class is obsolete. Use class Abc instead."</font>)]</font>
			:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#0000ff">public </font><font color="#0000ff">class </font><font color="#2b91af">SampleClass</font></font>

			<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"></font>

	== Coding guidelines ==		== Coding guidelines ==