Indentation
Indentation
Indentation must be used if the line is associated with the previous line. When indentation is needed, use conventional indentation (one “Tab”).
Example 1:
<div id="content">
<table>
<tr>
<td class="control_title">
</td>
</tr>
</table>
</div>
Example 2:
public string indentation
{
get
{
return _indentation;
}
set
{
_indentation = value;
}
}
Wrapping Lines
Avoid lines longer than 120 characters. When an expression will not fit on a single line, break it with conventional indentation in new line.
Example:
string _xmlData = "<?xml version=\"1.0\"?>" + "\r\n" +
"<!DOCTYPE ddtp=\"http://dtd.wctp.org/wctp-dtd-v1r1.dtd\">" + "\r\n" +
"<wctp-Operation wctpVersion=\"wctp-dtd-v1r1\">" + "\r\n" +
"<wctp-SubmitRequest>" + "\r\n" +
"<wctp-SubmitHeader submitTimestamp=\"" + _timestamp + "\">" + "\r\n" +
"<wctp-Originator senderID=\"application@chron.com\"/>" + "\r\n" +
"<wctp-MessageControl messageID=\"001\"/>" + "\r\n" +
"<wctp-Recipient recipientID=\"" + recipient + "@arch.com\"/>" + "\r\n";
Naming Convention (Server Code)
Identifier Naming Convention
| Identifier | Case | Examples | Rules |
| Comment | Clear, short and descriptive. | ||
| Class | PascalCase | Person BankVault ImageSprite |
Acronyms of 3 or more letters should use pascal case instead of all caps. Avoid abbreviations (unless it is widely used, like URL, HTML). Keep names simple and descriptive. No underscores. Nouns. |
| Method(Private) | PascalCase with “_” prefix | _UpdateScore(…) _UpdateUrl(…) _UpdateID(…) |
Acronyms of 3 or more letters should use pascal case instead of all caps. Avoid abbreviations (unless it is widely used, like URL, HTML). No underscores. Verbs. |
| Method(Public) | PascalCase | UpdateScore(…) UpdateUrl(…) UpdateID(…) |
Acronyms of 3 or more letters should use pascal case instead of all caps. Avoid abbreviations (unless it is widely used, like URL, HTML). No underscores. Verbs. |
| Method for Ajax (Private and public) | PascalCase following text “Ajax” | SavePeopleAjax GetPropertyAjax _DeleteGroupAjax |
Method for ajax is a method that only called with ajax. For private, prefix with “_”. |
| Common Method (Private and public) | PascalCase following text “Common” | GetStateCommon _GetAnswerCommon _SaveStateCommon |
Common method is a method that could be use in different controllers/pages. For private, prefix with “_”. |
| Namespace | PascalCase | Chronicle.IT.BasicFunctions Chronicle.IT.Ftp Chronicle.IT.Xml |
Acronyms of 3 or more letters should use pascal case instead of all caps. Avoid abbreviations (unless it is widely used, like URL, HTML). No underscores. Use $lt;company_name$gt; as root. |
| Interface | PascalCase with “I” prefix | IDisposable IWidgetXml IUserID |
Acronyms of 3 or more letters should use pascal case instead of all caps. Avoid abbreviations (unless it is widely used, like URL, HTML). No underscores. |
| Parameter | camelCase | recordID personName previousUrl |
Acronyms of 3 or more letters should use pascal case instead of all caps. Avoid abbreviations (unless it is widely used, like URL, HTML). No underscores. Optional object type can be added. See “Object Type Naming Convention” section. |
| Property / Variable (Private) | camelCase with “_” prefix | _backColor _internalXml _userID |
Acronyms of 3 or more letters should use pascal case instead of all caps. Avoid abbreviations (unless it is widely used, like URL, HTML). No underscores (except the prefix). Optional object type can be added. See “Object Type Naming Convention” section. |
| Property / Variable (Public) | PascalCase | BackColor InternalXml UserID |
Acronyms of 3 or more letters should use pascal case instead of all caps. Avoid abbreviations (unless it is widely used, like URL, HTML). No underscores. Optional object type can be added. See “Object Type Naming Convention” section. |
Object Type Naming Convention
Additional object’s type can be added to precede some identifiers in order to distinguish the object type. If the object’s type is added, abbreviate the object type according to the following rules:
| Object Type | Abbreviated Object Type | Examples |
| Array | arr | _arrBackColors _arrInternalXml arrUserID |
| String | str | _strBackColor _strInternalXml strUserID |
Naming Convention (Client Code)
CSS & HTML
| Identifier | Case | Examples | Rules |
| Class | dash-separated | sort-column portlet-header portlet-content |
Acronyms of 3 or more letters should use pascal case instead of all caps. Avoid abbreviations (unless it is widely used, like URL, HTML). Keep names simple and descriptive. No underscores. Nouns. All lowercase. |
| HTML Element | camelCase | ddlPropertyType txtName |
Start with 3 letters of specified element. |
| HTML Element (For) | PascalCase | Group Property People.FirstName |
For is html element generated by mvc html helper that bound to the specific property. |
JavaScript
| Identifier | Case | Examples | Rules |
| Comment | Clear, short and descriptive. | ||
| Parameter | camelCase | dashboardResult peopleResult currentUrl |
Acronyms of 3 or more letters should use pascal case instead of all caps. Avoid abbreviations (unless it is widely used, like URL, HTML). No underscores. Optional object type can be added. See “Object Type Naming Convention” section. Nouns. |
| Property / Variable (Private) | camelCase with “_” prefix | _savePreference _currentUrl _parent |
Acronyms of 3 or more letters should use pascal case instead of all caps. Avoid abbreviations (unless it is widely used, like URL, HTML). No underscores (except the prefix). Optional object type can be added. See “Object Type Naming Convention” section. Nouns. |
| Property / Variable (Public) | PascalCase | SavePreference CurrentUrl Parent |
Acronyms of 3 or more letters should use pascal case instead of all caps. Avoid abbreviations (unless it is widely used, like URL, HTML). No underscores (except the prefix). Optional object type can be added. See “Object Type Naming Convention” section. Nouns. |
Json
| Identifier | Case | Examples | Rules |
| Name | PascalCase | Person Status Parent Children |
Acronyms of 3 or more letters should use pascal case instead of all caps. Avoid abbreviations (unless it is widely used, like URL, HTML). Keep names simple and descriptive. No underscores. Nouns. Avoid using two words or more. |
Stack 24/7 