JSP中的注释

JSP中的注释
JSP中最好使用
// 这种注释优于 /**/ 因为MyEclips编辑器可以将这种注释内容显示为绿色，易于与代码区分
而不是
/* 这种注释尽量不要用，因为MyEclips将里面的内容显示为黑色，不易与代码区分开来 */
描述性注释
<%
//程序名称：通常是该JSP文件名
//程序功能：该JSP功能描述
//创建日期：2002-06-19 11:10:36（越精确越好）
//创建人 ：CrtHtml程序创建
//更新记录： 更新人    更新日期     更新原因/内容
//            人名        日期           原因
//例如：     niuzj 2006-08-23 YDtm需要在录入受益人信息时增加一个“性别”字段
%>
幸福的JSP通常用于前台显示和数据提交，由于功能相对简单，我们不提倡在JSP中加入太多java风格的注释。

Javascript的注释
我们Test系统大部分javascript的注释写的较为凌乱，终其原因，大部分人都是以java软件工程师的身份进入公司，因此对javascript不够重视，实际上javascript是一种解释执行的语言，我们页面所运行的javascript实际上是每次客户端请求时从后台服务器发送过去的，因此javascript体积越小页面传输速度越快。
幸福项目组要求，新建立的.js文件在程序能够被理解的时候尽量不要在里面添加注释。

描述性注释示例，如果创建一份通用的js文件这部分信息是不可少的：
/*************************************************************************
* <p>Title: Test 1.0</p>
* <p>Description: SScompanyTest管理系统</p>
* <p>Copyright: Copyright (c) 2005 SScompany, Co.Ltd. All Rights Reserved</p>
* <p>Company: SScompany </p>
* <p>WebSite: http://www.SScompany.com.cn</p>
*
* @author   : SScompany
* @version : 1.00
* @date     : 2006-11-08
* @direction: Test系统多行显示/输入表格
* @comment : XinYQ formatted on 2006-11-08
**************************************************************************/
但如果仅仅是创建一份用于某个单独页面逻辑的js文件，还是不要增加太多注释了，会影响速度的。
解释性注释
用于对js的function进行注释
/*****************************************************
* 保存集体投保单的提交（function的功能描述）
* 参数 ： (行参，由于javascript的function行参是没有类型标志的，最好在此告知参数类型)
* 返回值： （返回信息，注意冒号与参数列表对齐，并描述返回值类型）
*****************************************************
*/
提示性注释
除较为复杂的算法外，本文档不建议在Javascript文件大量编写提示性注释，此外，也不建议将业务逻辑放在javascript中，因为除了效率的考虑之外，javascript的安全性也值得怀疑。
提示性注释举例：
this.formName = formName || "fm"; //表单名称
this.name = name || ""; //实例名称
this.count = 0; //行输入对象的行数
this.add = 1; //是否可以允许增加，删除1表示可以，0表示不可以
this.select = 0; //是否可以选择，1表示可以，0表示不可以
this.title = 1; //是否现实title 1表示显示，0表示不显示

javascript注释可以参看common包中公司前辈们的大作，有些程序至今无人能改。考虑到Test系统的总销售额，用一字千金来形容这些代码也不为过。

HTML的注释
HTML中主要是解释性注释，便于阅读者知道某一个TABLE或者DIV上应该输入什么样的 字段。
CCtm项目组的HTML中有两种主要注释方法
HTML风格的注释方法，可用于所有HTML和JSP文件
<!-- HTML注释，会被发送到客户端，考虑到安全性，不推荐使用 -->
JSP 的注释方法同样可以注释HTML模块功能，只能用于JSP文件
<%-- JSP引擎会自动忽略的注释，不会被发送到客户端，推荐使用 --%>


2008-5-20 21:26
以上文字来自以下地址：
http://blog.csdn.net/l0979365428/archive/2007/10/22/1836477.aspx