搜档网
当前位置:搜档网 › SVN文档代码提交以及注释相关要求

SVN文档代码提交以及注释相关要求

SVN文档代码提交以及注释相关要求
SVN文档代码提交以及注释相关要求

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日已完成新配置服务器的切换)。

MyEclipse设置Java代码注释模板

设置注释模板的入口: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自动添加注释 我们在用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版 北京人民邮电出版社 著者:陈志泊王春玲 数据库原理与应用 北京清华大学出版社 著者:狄文辉宋真君白劲波

java开发注释规范规范

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代码生成工具使用说明文档 本文档是使大家能正确使用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的下来菜单,选中需要的一个或多个,在选中的这些表上点击右键,选择要生成的部分即可。

java注释模板