SVN文档代码提交以及注释相关要求
目前每期配置检查都发现有工程师不提交代码和文档的事情发生,综合了一下主要有以下3类原因:
●各项目配置库没有配备工程师私有目录,工程师担心最新修改的程序合入到版本后,会
影响到整体,所以未进行提交。
●工作完成后忘记了及时去共享最新工作成果;
●由于SVN提交时必须要写注释信息,少数工程师觉得写注释信息麻烦,所以就谎称项目
无进展,没有需要更新的代码和文档,达到不提交工作。
导致如下问题存在:
●项目过程中的中间产物公司没有收集到,需要存档保存;
●配置检查、审计及统计时,数据不准确,配置管理员不知道此项目是否确实如开发人员
所说已经停止,而项目管理者也不能确却了解项目的具体进展情况;
●工程师连续几天甚至一周才提交一次,中间无版本记录,出错后不可恢复,不可查询,
只能回退到一周前甚至更早以前的版本,中间产物将完全丢失;
●SVN注释信息敷衍,甚至无实际意义,没有说明做了什么事情,除工程师本人外,其他
工程师想要了解比较困难。
为解决目前存在的问题,使相关人员养成良好的工作习惯,从以下几方面规范配置管理:●在服务器上新建personal配置库,由工程师自行管理,除上级管理人员可查询外,其
他人员无查看权限。用于保存没有经过验证的工作有存档记录,不会影响到全局项目,也不会将私有操作的SVN版本记录叠加到具体项目中去;
工程师个人工作配置库: svn://scm/personal (scm小写)
●每次提交必须有相关修改说明(SVN的注释信息),以方便今后以及其他相关工程师查
阅,不符合规范(见附件2)的注释信息情况,将记录到每个人员的绩效考核中(分值见附件2)
●每周进行配置检查并统计SVN用户的活跃程度(SVN检查点见附件1),及详细修改内
容——SVN的注释信息(使用statsvn工具自动统计),将检查记录到每个人员的绩效考核中(分值见附件1)
说明:
只统计项目配置库,如项目配置库中无记录,而personal配置库中有提交记
录时,仍属正常情况。如果两个配置库都无记录,则属违规,上级领导需要核
实该工程师当天是否有实际工作。
附件1:SVN日常检查10条
附件2:SVN注释说明
1、SVN日志默认包含了:版本号,操作类型,作者,日期和被修改对象文件等5项信息,
在注释中不需要重复说明,只需说明修改的内容即可。
例如:
注意:
1、各配置库共用SVN账号信息,需自行保管好账号信息;
2、当前personal 配置库在scm配置服务器上,可直接从以上地址获取,为防止IP地址有变对SVN造成影戏哪个,从SVN客户端访问配置库时必须使用scm代替IP地址,外网访问时可向配置管理员索要具体svn地址(09年12月21日已完成新配置服务器的切换)。
设置注释模板的入口:Window->Preference->Java->Code Style->Code Template 然后展开Comments节点就是所有需设置注释的元素啦。现就每一个元素逐一介绍: 文件(Files)注释标签: /** * @Title: ${file_name} * @Package ${package_name} * @Description: ${todo} * @author chenguang * @date ${date} ${time} * @version V1.0 */ 类型(Types)注释标签(类的注释): /** * 类功能说明 * 类修改者修改日期 * 修改说明 * Title: ${file_name} * Description:清大海辉科技开发平台 * Copyright: Copyright (c) 2006 * Company:北京清大海辉科技有限公司 * @author ${user} * @date ${date} ${time} * @version V1.0 */ 字段(Fields)注释标签: /** * @Fields ${field} : ${todo} */ 构造函数标签: /** * Title: * Description: * ${tags} */
方法(Constructor & Methods)标签: /** * 函数功能说明 * ${user} ${date} * 修改者名字修改日期 * 修改内容 * @param ${tags} * @return ${return_type} * @throws */ getter方法标签: /** * @return ${bare_field_name} */ setter方法标签: /** * @param ${param} ${bare_field_name} */ 加注释快捷键:选中你要加注释的方法或类,按Alt + shift + J。
Eclipse自动添加注释 我们在用Eclipse开发工具编写代码时,常常需要在类的头部加上一下注释,标明类的作者,创建时间等等。我们常用的做法是: 方式1:在新建类时勾选:Generate comments 如图1。 图1 创建类时指定生成注释 这种方式固然可以生成,但是只会是Eclipse默认的,仅有@author xxxx
方式2:快捷键生成 第二种就是我们生成类的时,也许忘了勾选。那么我们就会使用Eclipse提供的快捷键ctrl+alt+j 图2 快捷键添加注释 当然这种方式也需要开发者,现将鼠标定位类名行或者方法名行。然后生成对应的注释。那么如果我们想要自己定义自己的注释呢? 方式三:自动生成自定义注释 Eclipse最大好处就是很多东西都能让开发者自己来定义。下面说说如何自定义生成注释。 3.1首先自定义注释模板 打开:windows-->preference -->Java-->code style -->code templates --> code -->new java file 按照如上操作打开到相应对话框,如下图3
图3:注释模板对话框 当进入到这个对话框后,点击右侧“Edit”编辑按钮,进入到注释模板编辑对话框,如下图4:
图4 编辑自定义注释模板 在这个对话框中编辑你想要的注释模板,编辑完成后点击OK。 附:注释基本模板: 当点击OK退出模板编辑对话框后,勾选:automatically add comments for new methods and types,如图5
图5 设置自动添加注释 当然,你还可以设置很多注释,包括getter、setter等等的注释,都在这里,有兴趣的你都可以多试试。
东北师范大学 外语培训机构数据库详细设计文档 雷蕾张丽云丁鼎孔祥楠 2009-11-1
目录 第一章引言 (1) 1.1项目说明 (1) 1.2文档目的 (1) 1.3参考资料 (1) 第二章设计流程图 (3) 2.1注册功能流程图 (3) 2.2用户登录功能流程图 (4) 2.3搜索课程功能流程图 (5) 2.3前台用户下载资料或留言功能流程图 (5) 2.3后台管理员功能流程图 (6) 第三章类规格说明 (7) 2.1模块类图 (7) 3.2 jsp页面说明 (8) 3.3类说明 (10) 第四章程序设计说明 (15)
第一章引言 1.1项目说明 1、在互联网络高速发展的今天,网站是企业在因特网上全面介绍公司信息的一个发布平台:可以把任何想让人们知道的东西放入网站,如公司简介、公司的厂房、生产设施、研究机构、产品的外观、功能及其使用方法等,都可以展示于网上。 2、网站树立培训机构形象,让别人看到自己,展示培训机构的实力。培训机构就能够在国内和世界"亮相",无疑是一种宣传机构、产品和服务的机会。从广告意义上看,培训机构网站事关机构形象建设,没有网站也谈不上机构形象。 3、主动抢占先机,培训机构建设自己的网站,这是时代发展的必然,任何一家培训机构要想跟上时代发展的潮流,必须要有展示自己的一个信息平台。为了不被竞争对手建立网站抢占先机,为了不落后于时代潮流,应该考虑建站的必要性。 4、可以扩大业务范围,可以与潜在客户建立商业联系:这是该网址最重要的功能之一,也是为什么那么多的国外企业非常重视网站建设的根本原因。现在,世界各国大的采购商主要都是利用互联网络来寻找新的产品和新的供应商,因为这样做费用最低,效率最高。原则上,全世界任何地方的人,只要知道了公司的网址,就可以看到公司的产品。因此,关键在于如何将公司网址推介出去。一种非常实用而有效的方法是将公司的网址登记在全球著名的搜索引擎(如Google,百度,雅虎等)上,并选择与公司的产品及服务有关的关键字,则可以使潜在的客户能够容易地找到公司和产品。这正是国际商业上通行的做法,而且被实践证明是十分有效的。 5、给广大热爱外语,渴望了解外语信息的群体提供一个方便快捷的平台。 1.2文档目的 该文档的阅读群体是该项目组的全部成员,为了让所有成员能对本网站的数据库构成,数据流向有个深刻的了解,方便在以后的编程中合理运用。 1.3参考资料 数据库原理及应用教程2版 北京人民邮电出版社 著者:陈志泊王春玲 数据库原理与应用 北京清华大学出版社 著者:狄文辉宋真君白劲波
javadoc 是j2sdk里面一个非常重要的工具,如果你按照规范在java的源代码里面写好注释的话,那么它就可以生成相应的文档。开发者察看起来会非常方便。很多IDE都可以直接生成javadoc的,这里介绍如何写javadoc以及如何在eclipse下生成javadoc。 javadoc通常从package、公开类或者接口、公开或者受保护的字段、公开或者受保护的方法提取信息。每条注释应该是以/**开始以*/结尾。例如 /** * * @param id the coreID of the person * @param userName the name of the person * you should use the constructor to create a person object */ public SecondClass(int id,String userName) { this.id = id; https://www.sodocs.net/doc/1d3179634.html,erName = userName; } 注释应该写在要说明部分的前面,如上所示。并且在其中可以包括html的标记,如果上面没有标记的话,那么you should usr the ......将会在javadoc里面紧跟@param userName....,这样不是我们希望的。一般注释可以分为类注释、方法注释、字段注释等。下面分别作简单的介绍 类注释 类注释应该在import语句的后面在类声明的前面,比如 package com.north.java; /** * @author ming * * this interface is to define a method print() * you should implements this interface is you want to print the username * @see com.north.ming.MainClass#main(String[]) */ public interface DoSomething { /** * @param name which will be printed * @return nothing will be returned * */
JToolpad代码生成工具使用说明文档 本文档是使大家能正确使用JToolpad工具,从而缩短开发时间,简化开发流程,生成规范且正确的代码。 1.打开JToolpad 如果本机有此工具则在开始菜单->所有程序中打开即可,若本机没有此程序,则可在局域网内找到,http://192.168.60.21/jtoolpad/ 点击链接即可打开工具。主界面如下:
打开已经编译好的pdm文件,即可导入数据结构
3配置属性 选择菜单中的模型选项,打开属性即可弹出如下对话框 1.应用代码:暂时无具体意义 2.Sysframework基本包名:是工具包的存放路径,随项目变化会相应的发生变化 3.应用基准包名:是具体的应用包的名称,比如上面的这个包platfrom下就会是具体的dto, web,service等 4.Java源代码目录:是具体的Java代码存放位置,此相必须指向component文件夹,在 component文件夹下就是相应的应用基准包名目录,如:component\com\ chinainsurance\application\platform\..... 5.Web应用根目录:是具体的web发布页面的存放位置,此项必须指向webapps文件夹, 在此文件夹下是具体的web发布路径。 配置好以上路径后确定即可。 注意:此项路径必须指向实际开发路径不能指向临时文件夹或备份文件夹。应为部分代码的生成是基于某些已经存在的文件而生成的,这点切记! 4生成代码方法 生成代码有两种方式: 第一种就是选择所需要的一个或多个表生成部分文件:方法是打开Tables的下来菜单,选中需要的一个或多个,在选中的这些表上点击右键,选择要生成的部分即可。
程序代码注释编写规范 为提高控制程序的阅读性与可理解性,现制定相关代码程序代码注释编写的编写规范。 一般情况下,源程序有效注释量必须在20%以上,注释的原则是有助于对程序的阅读理解,在该加的地方都加了,注释不宜太多也不能太少,注释语言必须准确、易懂、简洁。 常规注释有以下两种方式。 单行:以"//"符号开始,任何位于该符号之后的本行文字都视为注释。 多行:以"/*"符号开始,以"*/"结束。任何介于这对符号之间的文字都视为注释。 一、说明性文件 说明性文件(如头文件.h文件、.inc文件、.def文件、编译说明文件.cfg等)头部应进行注释,注释必须列出:版权说明、版本号、生成日期、作者、内容、功能、与其它文件的关系、修改日志等,头文件的注释中还应有函数功能简要说明。 示例:下面这段头文件的头注释比较标准,当然,并不局限于此格式,但上述信息建议要包含在内。 /************************************************* COPYRIGHT (C), MicTiVo International. Co., Ltd. File NAME: // 文件 Author: Version: Date: // 作者、版本及完成日期 DESCRIPTION: // 用于详细说明此程序文件完成的主要功能,与其他模块 // 或函数的接口,输出值、取值范围、含义及参数间的控 // 制、顺序、独立或依赖等关系 Others: // 其它内容的说明 Function List: // 主要函数列表,每条记录应包括函数名及功能简要说明 1.... History: // 修改历史记录列表,每条修改记录应包括修改日期、修改 // 者及修改内容简述 1. Date: Author: Modification: 2. .. *************************************************/ 二、源文件头 源文件头部应进行注释,列出:版权说明、版本号、生成日期、作者、模块目的/功能、主要函数及其功能、修改日志等。 示例:下面这段源文件的头注释比较标准,当然,并不局限于此格式,但上述信息建议要包含在内。 /************************************************************ COPYRIGHT (C), MicTiVo International. Co., Ltd. FileName: Author:
文档名称:软件总代码行数_软件注释 率分析 作者: 日期:
1. cncc 1.1 工具简介 度量工具名称cncc 网址https://www.sodocs.net/doc/1d3179634.html,/ 操作方式命令行 实现语言C++ 适用的操作系统Windows 可以度量的属性code-lines, empty-lines, comment-lines, total-lines 备注 1.2 工具优缺点总结 最新版本 cncc-1-3-1,在sourceforge中2004年已经停止更新。最大的优点是源代码全部存于一个cpp文件,便于集成。 缺点: 1.代码基本没有注释。 2.下载的代码编译有9个错误。 3.费了2个多小时也没搞定。 1.3 使用例程 无。 2. CodeCount 2.1 工具简介 度量工具名称CodeCount 网址https://www.sodocs.net/doc/1d3179634.html,/downloads421/sourcecode/windows
/control/detail1783204.html 操作方式GUI 实现语言C++ 适用的操作系统Windows 可以度量的属性total-lines, empty-lines, comment-lines, code-lines, 备注 2.2 工具优缺点总结 优点: 工具比较精简,统计源文件总行数、代码行数、空白行数、注释行数,代码有一定的注释。 缺点: 下载的源码是vc7工程,由于机器并没有vc7,利用工具进行工程类型转换,将vc7的工程转换为vc6的工作,编译出错。 核心代码如下: BOOL bCommentSet = FALSE; //注释行统计标识有"/*"时TRUE, "*/"时FALSE BOOL bQuatoSet = FALSE; //字符串统计标识首次一行有奇数个"时TRUE, 下一行有奇数个"时FALSE int nLength = (int)file.GetLength(); CString bufRead; int nLineCommentBegin = 0; while(file.ReadString(bufRead)!=FALSE) { BOOL bStatedComment = FALSE;//本行作为注释行是否已统计过 BOOL bStatedCode = FALSE; //本行作为代码行是否已统计过 nLines++; bufRead.TrimLeft(); //先将文件头的空格或制表符去掉 if(bufRead.GetLength()==0) //为空白行
系统编码规范 1.目的 为了统一开发过程中关于代码编写时的编写规范和具体开发工作时的编程规范,保证代码的一致性,便于交流和维护,特制定此规范。 2.适用范围 本规范适用于开发组全体人员,为详细设计,代码编写和代码审核提供参考和依据。 3.代码格式 在编写代码过程中,建议遵循以下规则。 (1)缩进规则:使用四个空格作为每层次代码的缩进值。 (2)在括号对对齐的位置垂直对齐左右括号,如: For(i=0;i++) { …. } (3)沿逻辑结构行缩进代码,如:
If…then If…then … Else … End if Else … End if (4)为了防止在阅读代码时左右滚动代码编辑器,每行代码或注释不得超过一个显示屏。 (5)当一行分别为几行时,通过将串联运算符放在每行的末尾而不是开头,清楚地表示没有后面的行是不完整的。 (6)Case 规则:default case 总应该存在,如果不允许到达,则应该保证:若到达了就会触发一个错误。Case的选择条件最好使用int或string类型。 (7)对齐规则:变数的申明和初始化都应对齐。
4.注释规范 4.1. 块注释 //用户名非空 验证+长度验证 +合法性验证 function checkUserName(){ var name = document.myform1.txtUser; if(name.value==""){ alert("请输入用户名"); name.focus(); return false; }else if(name.value.length<4||name.value.length>16){// 用户名长度验证 alert("用户名输入的长度4-16个字符"); name.select(); return false; } 4.2. 行注释 用户名非 空验证+长 度验证+合 法性验证 function checkUserName(){ var name = document.myform1.txtUser; if(name.value==""){ alert("请输入用户名"); name.focus(); return false; }else if(name.value.length<4||name.value.length>16){//用户名 长度验证 alert("用户名输入的长度4-16个字符"); name.select(); return false;
网上资料:共享 Window --> Java --> Code Style --> Code Templates --> Comments --> types --> Edit /** * * 项目名称:${project_name} * 类名称:${type_name} * 类描述: * 创建人:${user} * 创建时间:${date} ${time} * 修改人:${user} * 修改时间:${date} ${time} * 修改备注: * @version * */ ---------------------------------------------------------------------------------------------------------- 设置注释模板的入口:Window->Preference->Java->Code Style->Code Template 然后展开Comments节点就是所有需设置注释的元素啦。现就每一个元素逐一介绍: 文件(Files)注释标签: /** * @Title: ${file_name} * @Package ${package_name} * @Description: ${todo} * @author A18ccms A18ccms_gmail_com * @date ${date} ${time} * @version V1.0 */ 类型(Types)注释标签(类的注释):
/** * @ClassName: ${type_name} * @Description: * @author: 秦天朋 * @date ${date} ${time} * * ${tags} */ 字段(Fields)注释标签: /** * @Fields ${field} : ${todo}(用一句话描述这个变量表示什么) */ 构造函数标签: /** * Title: * Description: * ${tags} */ 方法(Constructor & Methods)标签: /**
(国际贸易)贸易方式代码 表说明
(二)海关通关系统常用代码表说明 监管方式代码表说明 进出口货物海关监管方式(以下简称监管方式),即现行进出口货物报关单“贸易方式”,是以国际贸易中进出口货物的交易方式为基础,结合海关对进出口货物的征税、统计及监管条件综合设定的海关对进出口货物的管理方式。 由于海关对不同监管方式下进出口货物的监管、征税、统计作业的要求不尽相同,因此为满足海关管理的要求,报头自动化系统的监管方式代码采用四位数字结构,其中前俩位是按海关监管要求和计算机管理需要划分的分类代码,后俩位为海关统计代码。 壹般贸易 壹、定义和代码 壹般贸易是指我国境内有进出口运营权的企业单边进口或单边出口的贸易。本监管方式代码为”0110“简称:壹般贸易。 二、适用范围 (壹)本监管方式包括: 1.以正常交易方式成交的进出口货物; 2.来料养殖、来料种植进出口货物; 3.个体工商业者委托进口的小型生产工具; 4.旅游旅馆、酒店进口营业用的食品和餐佐料等; 5.外商投资企业进口供加工内销产品的料件; 6.贷款援助的进出口货物(包括我方利用贷款款项自行采购进口的物资); 7.外商投资企业用国产原材料加工产品出口或经批准自行收购国内产品出口的货物; 8.国内运营租赁业务的企业购进供出租用的货物; 9.运营保税仓库业务的企业购进供自用的货物;
10.运营免税品和免税外汇商品的企业购进自用的手推车、货架等货物; 11.外籍船舶、飞机于我国境内添加的国产燃料; 12.对台间接贸易进出口货物。 (二)本监管方式不包括: 1.进出口货样广告品,监管方式代码为“3010”(货样广告品A)、“3039”(货样广告品B); 2.无进出口运营权的单位经批准临时进出口货物,监管方式代码为“9739”; 3.进料加工贸易中,对方有价或免费提供的机器设备(0420或0320); 4.运回国内对外承包工程期间于国外获取的机器、设备,监管方式代码为“3410”; 5.境外劳务合作项目,对方以实物产品低偿我劳务人员工资所进口的货物(如钢材、木材、化肥、海产品等),监管方式代码为“3410”。 易货贸易 壹、定义和代码 易货贸易是指不通过货币媒介而直接用出口货物交换进口货物的贸易。本监管方式代码为“0130”,简称:易货贸易。 二、适用范围 本监管方式包括和原苏联、东欧等二十六国以及和其他国家的易货贸易。 本监管方式不包括: 1.对台小额贸易中签订易货合同的贸易,应为“其他贸易”(9739)。 2.边境小额贸易中签订易货合同的贸易,应为“边境小额”(4019)。
简介FHQ313596790 Springmvc+mybatis组合框架 Oracle和mysql俩版本 1各包说明 1.1Src 1.controller:业务处理包(日常代码维护主要包) 2.dao:增删改查的接口(无需操作,不用管它) 3.entity:实体类包(存放实体类) 4. filter:登录顾虑验证器(可以在此添加一段代码,让tomcat启动后立即自动执 行 需要配置web.Gml 5.interceptor:session有效期验证 请求的连接中GGG.do不包含login,logout,code,app 等字符的,都会被判断session存在与否,否:跳转到登录,是:跳转到相应地址 6.Listener:在web容器启动时由WebAppConteGtListener初始化 7.Plugin:分页插件(已经处理好,无需更改)
8.Listene:MyEGceptionResolver异常处理 9.Util所有工具类(发邮件,发短信,日期格式化等) 1.2resources 1.mybatis:对应的配置文件 2.spring:spring的配置文件ApplicationConteGt.Gml 3.log4j日志处理配置,可设置生成日志文件到硬盘的某个目录下 4.dbconfigerties:数据库链接池配置 5.shior配置,在spring/ApplicationConteGt.Gml 1.2WebRoot admin:存放配置文件,代码生成器生成的代码(相对tomcat的目录) plugins:插件存放目录 static:jscssimg等存放目录 jsp:在WEB-INF目录下 增删改查流程 增加:(form表单提交数到后台在存入数据库) form表单action=”user/saveU.do” 1.比如新增用户,”user”对应的是
在软件开发的过程中总是强调注释的规范,但是没有一个具体的标准进行说明,通常都是在代码编写规范中简单的描述几句,不能作为一个代码注释检查的标准和依据,做什么都要有一个依据吗:),现在我特整理了一个《Java的注释规范》,内容来自网络、书籍和自己的实际积累。 JA V A注释规范 版本/状态作者版本日期 1.0 ghc 2008-07-02 一、背景 1、当我们第一次接触某段代码,但又被要求在极短的时间内有效地分析这段代码,我们需要什么样的注释信息? 2、怎么样避免我们的注释冗长而且凌乱不堪呢? 3、在多人协同开发、维护的今天,我们需要怎么样的注释来保证高质、高交的进行开发和维护工作呢? 二、意义 程序中的注释是程序设计者与程序阅读者之间通信的重要手段。应用注释规范对于软件本身和软件开发人员而言尤为重要。并且在流行的敏捷开发思想中已经提出了将注释转为代码的概念。好的注释规范可以尽可能的减少一个软件的维护成本, 并且几乎没有任何一个软件,在其整个生命周期中,均由最初的开发人员来维护。好的注释规范可以改善软件的可读性,可以让开发人员尽快而彻底地理解新的代码。好的注释规范可以最大限度的提高团队开发的合作效率。长期的规范性编码还可以让开发人员养成良好的编码习惯,甚至锻炼出更加严谨的思维能力。 三、注释的原则 1、注释形式统一 在整个应用程序中,使用具有一致的标点和结构的样式来构造注释。如果在其他项目组发现他们的注释规范与这份文档不同,按照他们的规范写代码,不要试图在既成的规范系统中引入新的规范。 2、注释的简洁 内容要简单、明了、含义准确,防止注释的多义性,错误的注释不但无益反而有害。 3、注释的一致性 在写代码之前或者边写代码边写注释,因为以后很可能没有时间来这样做。另外,如果有机会复查已编写的代码,在今天看来很明显的东西六周以后或许就不明显了。通常描述性注释先于代码创建,解释性注释在开发过程中创建,提示性注释在代码完成之后创建。修改代码的同时修改相应的注释,以保证代码与注释的同步。 4、注释的位置 保证注释与其描述的代码相邻,即注释的就近原则。对代码的注释应放在其上方相邻或右方的位置,不可放在下方。避免在代码行的末尾添加注释;行尾注释使代码更难阅读。不过在批注变量声明时,行尾注释是合适的;在这种情况下,将所有行尾注释要对齐。 5、注释的数量 注释必不可少,但也不应过多,在实际的代码规范中,要求注释占程序代码的比例达到20%左右。注释是对代码的“提示”,而不是文档,程序中的注释不可喧宾夺主,注释太多了会让人眼花缭乱,注释的花样要少。不要被动的为写注释而写注释。 6、删除无用注释
Zdeveloper2.x代码规范1 ZDeveloper命名规范 常见JAVA包命名(以platform插件为例)。 2 公共包 plugins存放所有插件配置文件; lang存放所有插件国际化配置文件; JAVA存放所有插件java类文件; DB目录存放zdm文件。
3 一般情况java包 *.ui子包存放本插件所属UI类(*.ui省略前面的com.zving.platform,下同); *.service子包存放本插件所属扩展服务类; *.service.impl子包存放扩展服务项实现类; *.extend子包存放本插件扩展相关的类( 扩展点接口类或抽象类) ; *.extend.impl子包存放本插件扩展实现类( 扩展行为或其它扩展实现类) ; *.bl子包存放本插件所属后台业务逻辑类。 4 特殊扩展服务用到java包 *.code子包存放本插件所属扩展代码管理扩展服务的扩展项类; *.privilege子包存放本插件扩展菜单权限服务的扩展项类; *.config子包存放本插件扩展配置项扩展服务的扩展项类; *.properties子包存放本插件扩展栏目或站点配置项相关的扩展服务的扩展项类; *.tag子包存放本插件扩展标签服务的扩项类; *.tempalte子包存放本插件扩展模板服务的扩展项类;
( 插件包的命名参展以上方式, 项目需要能够酌情添加有一定意义的子包) 5 插件包 插件包统一以”com.zving.”+插件名称来命名(公司名称域名+插件名称)。 6 插件类 插件名称+”Plugin”, 位于插件所属包根目录下。 7 插件配置文件 ”com.zving.”+插件名称+”.plugin”。 8 UI类 页面名称+”UI”, 类存放位置为”com.zving.”+插件名称+”.ui”子包。
简介FH Q313596790 Springmvc + mybatis组合框架 Oracle 和mysql俩版本 1各包说明 1.1Src 1.controller:业务处理包(日常代码维护主要包) 2.dao:增删改查的接口(无需操作,不用管它) 3.entity:实体类包(存放实体类) 4. filter:登录顾虑验证器(可以在此添加一段代码,让tomcat启动后立即自动执行 需要配置web.xml 5.interceptor:session有效期验证
请求的连接中*xx.do 不包含login,logout,code,app 等字符的,都会被判断session存在与否,否: 跳转到登录,是: 跳转到相应地址 6.Listener:在web容器启动时由WebAppContextListener初始化 7.Plugin :分页插件(已经处理好,无需更改) 8.Listene:MyExceptionResolver异常处理 9.Util所有工具类(发邮件,发短信,日期格式化等) 1.2resources 1.mybatis :对应的配置文件 2.spring :spring的配置文件ApplicationContext.xml 3.log4j 日志处理配置,可设置生成日志文件到硬盘的某个目录下 4.dbconfigerties : 数据库链接池配置 5.shior配置,在spring/ApplicationContext.xml
1.2WebRoot admin :存放配置文件,代码生成器生成的代码(相对tomcat的目录) plugins : 插件存放目录 static : jscssimg等存放目录 jsp : 在WEB-INF 目录下
IDEA类和方法注释模板设置 作者:wRitchie 来源:https://www.sodocs.net/doc/1d3179634.html, IDEA自带的注释模板不是太好用,整理了一下制作了一份比较完整的模板,这里设置的注释模板采用Eclipse的格式,下面先贴出Eclipse的注释模板,我们就按照这种格式来设置: 类注释模板: 方法注释模板: 一、首先我们来设置IDEA中类的模板: 设置类注释模板 1.选择File–>Settings–>Editor–>File and Code Templates–>Includes–>File Header.
2、效果图展示 IDEA没有智能到自动创建方法注释,需手动为方法添加注释,使用Eclipse时我们生成注释的习惯是/**+Enter,也按照这种习惯来设置IDEA的方法注释 1、File-->Settings-->Editor-->Live Templates
(1)新建组:命名为wRitchie (2)新建模板:命名为*
注:因为IDEA生成注释的默认方式是:/*+模板名+快捷键(例:若设置模板名为add,快捷键用Tab,则生成方式为/*add+Tab)若不采用这样的生成方式,IDEA中没有内容的方法将不可用,例如:获取方法参数的methodParameters()、获取方法返回值的methodReturnType() (3)设置生成注释的快捷键 (4)设置模板 模板内容如下,注意第一行,只有一个“*”而不是“/*”,在设置参数名时必须用:${参数名}$的方式,否则第五步中读取不到你设置的参数名 * * @Author: wRitchie * @Description: $description$ * @Param: $params$ * @return: $returns$ * @Date: $date$ $time$
代码编写规范说明书(c#.net与https://www.sodocs.net/doc/1d3179634.html,)目录 1 目的 2 范围 3 注释规范 3.1 概述 3.2 自建代码文件注释 3.3 模块(类)注释 3.4 类属性注释 3.5 方法注释 3.6 代码间注释 4 命名总体规则 5 命名规范 5.1 变量(Variable)命名 5.2 常量命名 5.3 类(Class)命名 5.4 接口(Interface)命名 5.5 方法(Method)命名 5.6 名称空间Namespace)命名 6 编码规则 6.1 错误检查规则 6.2 大括号规则 6.3 缩进规则 6.4 小括号规则 6.5 If Then Else规则 6.6 比较规则 6.7 Case规则 6.8 对齐规则 6.9 单语句规则 6.10 单一功能规则 6.11 简单功能规则 6.12 明确条件规则 6.13 选用FALSE规则 6.14 独立赋值规则 6.15 定义常量规则 6.16 模块化规则 6.17 交流规则 7 编程准则 7.1 变量使用 7.2 数据库操作 7.3 对象使用 7.4 模块设计原则 7.5 结构化要求 7.6 函数返回值原则 8 代码包规范 8.1 代码包的版本号
8.2 代码包的标识 9 代码的控制 9.1 代码库/目录的建立 9.2 代码归档 10 输入控制校验规则 10.1 登陆控制 10.2 数据录入控制 附件1:数据类型缩写表 附件2:服务器控件名缩写表 1 目的 一.为了统一公司软件开发设计过程的编程规范 二.使网站开发人员能很方便的理解每个目录,变量,控件,类,方法的意义 三.为了保证编写出的程序都符合相同的规范,保证一致性、统一性而建立的程序编码规范。 四.编码规范和约定必须能明显改善代码可读性,并有助于代码管理、分类范围适用于企业所有基于.NET平台的软件开发工作 2 范围 本规范适用于开发组全体人员,作用于软件项目开发的代码编写阶段和后期维护阶段。 3 注释规范 3.1 概述 a) 注释要求英文及英文的标点符号。 b) 注释中,应标明对象的完整的名称及其用途,但应避免对代码过于详细的描述。 c) 每行注释的最大长度为100个字符。 d) 将注释与注释分隔符用一个空格分开。 e) 不允许给注释加外框。 f) 编码的同时书写注释。 g) 重要变量必须有注释。 h) 变量注释和变量在同一行,所有注释必须对齐,与变量分开至少四个“空格”键。 如:int m_iLevel,m_iCount; // m_iLevel ....tree level // m_iCount ....count of tree items string m_strSql; //SQL i) 典型算法必须有注释。 j) 在循环和逻辑分支地方的上行必须就近书写注释。 k) 程序段或语句的注释在程序段或语句的上一行 l) 在代码交付之前,必须删掉临时的或无关的注释。 m) 为便于阅读代码,每行代码的长度应少于100个字符。 3.2 自建代码文件注释 对于自己创建的代码文件(如函数、脚本),在文件开头,一般编写如下注释: /****************************************************** FileName: Copyright (c) 2004-xxxx *********公司技术开发部 Writer: create Date: Rewriter:
设置注释模板的入口: Window->Preference->Java->Code Style->Code Template 然后展开Comments 节点就是所有需设置注释的元素啦。现就每一个元素逐一介绍: 文件(Files)注释标签: /** * @Project: ${project_name} * @Title: ${file_name} * @Package ${package_name} * @Description: ${todo} * @author jeffshaw jeff_chon@https://www.sodocs.net/doc/1d3179634.html, * @date ${date} ${time} * @Copyright: ${year} https://www.sodocs.net/doc/1d3179634.html, Inc. All rights reserved. * @version V1.0 */ 类(Types)注释标签(类的注释): /** * @ClassName: ${type_name} * @Description: ${todo} * @author jeffshaw jeff_chon@https://www.sodocs.net/doc/1d3179634.html, * @date ${date} ${time} * * ${tags} */ 字段(Fields)注释标签: /** * @Fields ${field} : ${todo} */ 构造函数标签: /** * Title: * Description:
* ${tags} */ 方法(Constructor & Methods)标签: /** * @Title: ${enclosing_method} * @Description: ${todo} * @param ${tags} 设定文件 * @return ${return_type} 返回类型* @throws */ 覆盖方法(Overriding Methods)标签: /* (非 Javadoc) * Title: ${enclosing_method} * Description: * ${tags} * ${see_to_overridden} */ 代表方法(Delegate Methods)标签: /** * ${tags} * ${see_to_target} */ getter方法标签: /** * @return ${bare_field_name} */
竭诚为您提供优质文档/双击可除 idea,注释模板 篇一:idea快捷键 一常用快捷键 alt+回车导入包,自动修正,当引入的类需要异常捕获的时候 ctrl+shift+space自动补全代码,“new”字符,还可以引入强制转换的ctrl-alt-space可以自动导import类名或接口名提示,以及new后面的提示ctrl+n查找类 ctrl+shift+n查找文件 ctrl+shift+alt+n查找类中的方法或变量 ctrl+shift+alt+s:打开projectstructure ctrl+shift+F7选中文本,高亮显示所有该文本,按esc 高亮消失。ctrl+shift+F9编译类 ctrl+shift+F10运行类 crtl+shift++打开所有关闭的方法,crtl++打开当前关闭的方法 输入/**即可自(idea,注释模板)动写上该方法参数的注释
ctrl-shift-j快捷键把两行合成一行并把不必要的空 格去掉以匹配你的代码格式。ctrl-shift-V快捷键可以将最近使用的剪贴板内容选择插入到文本。使用时系统会弹出一个含有剪贴内容的对话框,从中你可以选择你要粘贴的部分。 ctrl+shift+up/down代码向上/下移动。 ctrl+shift+t自动创建测试类 ctrl+alt+s:打开settings ctrl+alt+l格式化代码 ctrl+alt+o优化导入的类和包 ctrl+alt+V快速为后面生成变量,如new或者方法的返回类型。ctrl+alt+left/right返回至上次浏览的位置ctrl-alt-b可以导航到一个抽象方法的实现代码。 ctrl-alt-t,选中某段代码,可以快速包围用if,try 等。在options|Filetemplates|codetab中你还可以自己定制产生捕捉块的模板。 alt+insert生成代码(如get,set方法,构造函数等) alt+shift+up/down代码向上/下移动。 alt+up/down在方法与类属性间快速移动定位 alt+F1查找代码所在位置 alt+1快速打开或隐藏工程面板 alt+left/right切换代码视图 alt+F3,选中文本,逐个往下查找相同文本,并高亮显