C#, SQL, XML, HTML, CSS, JavaScript 中的源代码注释样式
5.00/5 (1投票)
这里是 C#, SQL, XML, HTML, CSS, JavaScript 中的一些源代码注释样式
开发人员花费数月时间编写优秀的代码，而审查人员只有几个小时，甚至几分钟来提供建议和改进。然后，开发人员很难展示他们的工作。此时，注释被证明是一个很好的包装，可以提高代码的可见性，并从长远来看减少维护问题。互联网上有不同的注释样式和指南，但没有在一个单一的包中，因此本文是分享注释样式的一站式解决方案的理想包装。
让我们首先看看我最喜欢的 C#
单行注释或内联注释
这些注释使用最广泛，并且在解释代码时非常有用，以防万一在演练中突然出现速度障碍。这些写成
//declaring variables
int count=0;
string name=string.empty;
或者在编写复杂或令人困惑的逻辑时，需要逐步解释。
public void GetProductRatings
{
//Call third party rating service
}
注意：不要在包含 ‘//’ 注释的同一行中继续编写代码。这将注释您的代码，您可能会花费一些时间进行不必要的调试。
多行注释或描述性块
我总是说，如果某样东西可用，那么它将是有用的，只是使用频率可能不同。单行注释和多行注释的使用之间存在很大的混淆。我想说两者都很好，并且需要在将它们插入代码文件之前进行一些思考。假设，我们需要共享代码的完整逻辑，那么有必要使用多行注释或描述性块。我个人的建议是在每个页面的顶部仅使用一个描述性块，该块在单个位置描述页面的逻辑。这些注释写成
%***********************************************************************
Page Title: Employee
Author: CodeSpread
Description: This page contains the following logic
1.Extract the information of Employee : GetEmployeeDetails()
2.Enlist all the Employee: GetAllEmployee()
Created Date:
Modified Date:
************************************************************************%
看起来很酷！！
XML 注释功能
这是开发人员可以使用的最佳省时功能。假设您编写了一个像这样的函数
//put your cursor here to include XML comments
public employee GetEmployeeDetails(int employeeid)
{
//Implementation
}
只需在放置光标的位置键入 ‘/’ 3 次，瞧，您就插入了带有默认字段的 XML 注释。
/// <summary>
///
/// </summary>
/// <param name="employeeid"></param>
public employee GetEmployeeDetails(int employeeid)
{
//Implementation
}
根据您编写的逻辑自定义注释
/// <summary>
/// Function to extract employee details
/// </summary>
/// <param name="employeeid">employee id to filter the results</param>
public employee GetEmployeeDetails(int employeeid)
{
//Implementation
}
另一个建议是指定区域并提供代码文件的更集中的视图。这真的很有帮助。
#region Employee Details
/// <summary>
/// Function to extract employee details
/// </summary>
/// <param name="employeeid">employee id to filter the results</param>
public employee GetEmployeeDetails(int employeeid)
{
//Implementation
}
#endregion
SQL 注释
因此，我们转移到 SQL，这里的注释以单行或多行给出。两种格式如下
单行注释
这些是内联注释，以 ‘- -’ 两个连字符开头，并且仅限于单行。一个警告是在查询中包含单行注释时要小心，否则可能导致灾难性结果。例如
-- get employee details for employeeid=100
select * from employee where employeeid=100
在上面的示例中，您可以看到注释的大小与查询相似，因此建议不必要的注释或冗长的注释可能会破坏代码的可见性和包装的目的。请尽量避免这种情况并编写简洁的注释。
多行注释
与 C# 类似，在 SQL 中，注释以 ‘/*’ 开头，以 ‘*/’ 结尾。这些主要用于标头中，以提供有关查询的详细信息。
%****************************************************************************
*Stored procedure getallemployee will return all the employee data.
*Created By: CodeSpread
*Created Date:
*Modified Date:
******************************************************************************%
Create proc getallemployee
AS
select * from employee
Go
XML 注释
XML 只有一种语法可用，它独立于单行或多行功能。它以 ‘’ 开头。让我们看看
<booklist>
<book>
<name>XML</name>
<author>CodeSpread</author>
</book>
<!-- <book>
<name>HTML</name>
<author>CodeSpread</author>
</book>
</booklist>-->
在上面的例子中，第二个book节点被注释掉了。 我对包含 'CDATA' 的 XML 有一个建议，因为 '<' '>' 可能会阻止注释语法，因此在使用带有 CDATA 的 XML 中的注释时应小心。 例如
<booklist>
<book>
<name>XML</name>
<author>CodeSpread</author>
</book>
<!-- <book>
<name>HTML</name>
<author><![CDATA[ CodeSpread]-->;<!--]></author>-->
</book>
</booklist>-->
HTML 注释
与 XML 相同。
CSS 注释
CSS 中的注释是通过多行注释语法实现的，它以 ‘/*’ 开头，以 ‘*/’ 结尾。
/**********
.title
{
color:red
}
**********/
JavaScript 注释
JavaScript 中有三种类型的注释可用。让我们看看
内联注释
这些是单行注释。它以 ‘//’ 开头，并且作用域限定为当前行。
<script type="text/javascript">
function Hello()
{
//Display Message
alert("Hello World!")
}
</script>
多行注释
这些注释以 ‘/*’ 开头，以 ‘*/’ 结尾，并扩展到多行
/*******
JavaScript to display
‘Hello World’
**********/
<script type="text/javascript">
function Hello()
{
alert("Hello World!")
}
</script>
JavaScript 中的 HTML 注释
HTML 注释 ‘’ 也可以用于注释 JavaScript，但尾部的 ‘—>’ 无法被 JavaScript 块识别，因此使用双斜杠 ‘//’。
<script type="text/javascript">
<!--
function Hello()
{
alert("Hello World!")
}
//-->
</script>
结论
我们试图识别我们在日常开发中使用的所有常见注释语法。如果您想为 codespread.com 贡献代码，请发送消息至 admin@codespread.com。
CodeProject