`
ayaya
  • 浏览: 453791 次
  • 性别: Icon_minigender_1
  • 来自: 大连
社区版块
存档分类
最新评论

对日开发中的注释要求

阅读更多

java文件注释

java 代码
  1. /**  
  2.  *  
  3.  * File Name: UserLogin.java<br>  
  4.  *  
  5.  * Created:     2007/09/13<br>  
  6.  *  
  7.  * Original Author: BBX <br>  
  8.  *  
  9.  */  

Class注释

java 代码
  1. /**  
  2.  *   
  3.  * パッケージ名:jp.jal.logic<br>[译:package名:jp.jal.logic]  
  4.  *   
  5.  * クラス名:UserLogin.java<br>[译Class名:UserLogin.java]  
  6.  *   
  7.  * クラス概要:ユーザー登録画面ビン実装クラス<br>  
  8.  *   
  9.  * 作成者:XXXXX<br>  
  10.  *   
  11.  * 作成日:2007/09/13<br>  
  12.  *   
  13.  */  

变量注释

java 代码
  1. // ユーザーのパスワード   
  2. private String password;  

方法注释

java 代码
  1. /**  
  2.  * メソッド名:getUserlist<br>  
  3.  *   
  4.  * メソッド概要:ユーザー情報リストを取得する<br>  
  5.  *   
  6.  * @return String フォーワード文字列  
  7.  *   
  8.  * 作成日:2007/09/14  
  9.  */  
  10. public List getUserlist() {   
  11.   
  12.     // ユーザーリストを作成   
  13.     userlist = new ArrayList();   
  14.     // B処理DAOを初期化する   
  15.     UserDao dao = new UserDao();   
  16.     try {   
  17.         // データソース接続の設定   
  18.         dao.init();   
  19.         // ログ出力   
  20.         log.info("UserLogin----------------------->" + this.getId());   
  21.         // ユーザーIDでユーザー情報リストを取得する   
  22.         userlist = dao.getUserInfo(id);   
  23.     } catch (Exception e) {   
  24.         e.printStackTrace();   
  25.     }   
  26.     // ユーザー情報リスト   
  27.     return userlist;   
  28. }  


分享到:
评论
1 楼 抛出异常的爱 2007-09-14  
由于注释太多所以。。。。大多数代码是由原型考贝过来的

相关推荐

    C#开发注释规

    **C# 开发注释规范** C#编程语言在开发过程中,良好的注释习惯是确保代码可读性、可维护性和团队协作效率的关键。本文档旨在定义一套完整的C#开发注释规范,涵盖注释的内容、格式以及适用场景,帮助开发者遵循统一...

    各种开发语言注释清理工具

    总之,“各种开发语言注释清理工具”提供了便捷的方式,帮助开发者统一管理和清理代码中的注释,以满足特定的需求。无论是为了代码审查、版本控制还是文档生成,这种工具都能大大提高代码维护的效率。同时,正确使用...

    java 开发注释模板

    在做java 开发的时候,代码的注释会显得比较重要,良好的注释可以更方便的帮助我们理解代码模块的功能。

    spring 源码中文注释

    这份"spring 源码中文注释"包含了对Spring框架源码的详细解读,对于理解其工作原理、优化代码以及定制化开发具有重要意义。 首先,我们来看看Spring的核心组件——IoC容器。IoC容器是Spring的核心,它负责管理对象...

    myeclipse开发注释自动生成

    MyEclipse开发注释自动生成 MyEclipse是一款功能强大且流行的集成开发环境(IDE),它提供了丰富的功能来提高开发效率和代码质量。其中,自动生成注释是MyEclipse的一个重要特性,本文将详细介绍MyEclipse开发注释...

    学习iOS开发过程中,对iOS开发中常用头文件添加中文注释,方便查阅.zip

    这个压缩包"学习iOS开发过程中,对iOS开发中常用头文件添加中文注释,方便查阅.zip"提供了一个宝贵的资源,它包含了对iOS开发中常用头文件的中文注释,这对于中文环境下的开发者来说是一个非常实用的学习工具。...

    framework 英文变中文注释

    当开发者在Visual Studio(如VS2008)中使用.NET Framework进行开发时,这些中文注释会显示在IDE的代码提示和文档中,帮助开发者理解代码的功能和用法。 标签提到了".net中文注释"、"英文变中文注释"、"vs中文注释...

    java开发注释模板文件

    `CodeTemplates.xml` 文件是一个专门用于存储Java开发注释模板的配置文件,通常与集成开发环境(IDE)如IntelliJ IDEA或Eclipse等紧密相关。这个文件允许开发者自定义代码模板,以便在编写代码时快速插入预定义的...

    java开发注释规范

    java企业开发中的注释规范,方法、类、codetemplates

    java的注释规范(单行注释、多行注释、分块注释)

    java 注释规范是 Java 开发过程中不可或缺的一部分,它的目的是让项目中所有的文档都看起来像一个人写的,增加可读性,减少项目组中因为换人而带来的损失。java 注释规范可以分为三种:单行注释、多行注释和分块注释...

    mybatis逆向工程,带中文注释

    在这个名为"mybatis逆向工程,带中文注释"的项目中,我们将探讨如何配置和使用这个功能,特别是在处理中文注释时的注意事项。 首先,逆向工程(Reverse Engineering)是指从已有的程序或系统中提取结构或设计信息的...

    spring源码注释中文

    6. **Test**:测试模块支持在开发过程中对 Spring 应用进行单元测试和集成测试,提供了模拟对象、测试上下文框架以及与各种测试框架的集成。 7. **Spring Boot**:近年来,Spring Boot 成为了快速开发 Spring 应用...

    去掉c语言中的注释 支持中文注释

    在实际开发过程中,注释可能包含中文字符。本程序通过使用`wchar_t`类型或其他宽字符处理方式来支持中文注释。然而,在给出的示例代码中,并没有明确地处理中文字符,但由于C语言标准库中的字符串处理函数通常能够...

    java文档注释要求

    3. **缩进要求**:文档注释中的每一行都应与对应的类、方法等保持相同的缩进。 4. **第一行描述**:描述部分的第一行应为简短的一句话概括,用于生成索引页中的条目。 5. **HTML标签的使用**:文档注释支持HTML语法...

    VisualStudio系统注释中文包 第二版

    它包含了对Visual Studio内置类库、框架、API及各种控件的中文注释,覆盖了开发过程中的常见类和方法,使得开发者在查看这些代码时能够快速理解其功能和用法。例如,对于.NET Framework中的System.IO命名空间,用户...

    java开发代码注释情况统计工具

    这是本人自己开发的一款java代码注释统计工具,支持统计总行数,总代码行数,总注释行数,注释率,注释合格率自定义,统计详细,单个文件统计情况,可导出统计报告等! 注:本软件未捆绑jre(java环境),需要在已...

    spring 5 中文注释源码.rar

    新版 spring 5 中文注释源码,关键源码位置都有中文注释,方便阅读源码 spring源码解读 Spring框架是由于软件开发的复杂性而创建的。Spring使用的是基本的JavaBean来完成以前只可能由EJB完成的事情。然而,Spring的...

    Visual Studio 9.0中文注释补丁

    在Visual Studio 2008中,英文注释是默认的,这可能会对一些中文用户造成困扰,特别是在阅读和理解他人的代码时。中文注释补丁的出现解决了这一问题,它将原本的英文注释转化为中文,使得开发者能够更直观地理解代码...

    对日软件开发 式样书模板

    在对日软件开发中,"式样书"(Shikumi-sho)是至关重要的文档,它是日本软件工程中的一种规范,用于详细说明系统的功能、设计以及开发过程中的各项要求。式样书不仅有助于保证软件质量,也确保了开发团队与客户之间...

Global site tag (gtag.js) - Google Analytics