gitlab+jenkins+sonar做代码质量分析(hua 修正版)
gitlab+jenkins+sonar做代码质量分析
目录
一、安装前准备 (1)
#1.环境： (1)
#2.安装JDK (2)
二、sonarqube5.6 安装 (3)
#1.下载安装包 (3)
#2.创建数据库和账号 (3)
#3.配置sonar参数 (4)
#4.安装SonarQube Scanner (4)
#5.安装SonarQube runner (4)
#6.启动sonar (5)
三、手工测试 (7)
四、Jenkins安装 (8)
#1.jenkins安装 (8)
#2. Jenkins集成Sonar进行代码质量管理 (13)
3.配置gitlab (15)
#4.jenkins配置gitlab (18)
#5.测试（连gitlab一起配置） (20)
五、附 (29)
附一：jenkins升级 (29)
一、安装前准备
#1.环境：
centos6.5 64位，关闭了iptables、selinux
IP:192.168.0.75
GitLab：8.2.2我用的是源码编码安装中文版，建立git用户为Gitlab用户
Jenkins：jenkins2.24
主要作用是中介的作用，通过gitlab和SonarQube插件，连接gitlab和sonar
如果使用当客户端用git push代码就自动触发jenkins调用sonar做质量分析的话，需要gitlab配置Web Hooks(web钩子),发触发事件发给jenkins
SonarQube：SonarQube5.6主要是做代码质量分析
内存大小：最小3G，还是比较卡
#保持主机名和hosts名字一致
[root@vm5 ~]# hostname
vm5
[root@vm5 plugins]# cat /etc/hosts
127.0.0.1 localhost vm5 localhost4 localhost4.localdomain4
::1 localhost vm5 localhost6 localhost6.localdomain6
shutdown -r now
#安装git
rpm -Uvh https://https://www.wendangku.net/doc/452050543.html,/pub/epel/epel-release-latest-6.noarch.rpm
wget https://www.wendangku.net/doc/452050543.html,/enterprise/remi-release-6.rpm
rpm --import https://www.wendangku.net/doc/452050543.html,/RPM-GPG-KEY-remi
rpm -ih remi-release-6.rpm
yum install -y git
发现问题：
1. jenskins+gitlab+sonar 3个整合最低要3G内存，还是感觉很卡
2.SonarQube 因为内存3G还是很卡，固态磁盘还是卡，所以端口号起得很慢，约2分钟
3.jenkins默认用的是8080默认会用gitlab冲突，所以需要修改一下端口
#2.安装JDK
#因为sonar是基于java的，所以要安装JDK，其它安装环境要求
#https://www.wendangku.net/doc/452050543.html,/display/SONAR/Requirements
#如果有openJDK则要先卸载
cd /disk1/tools/
rpm -qa | grep java
#去oracle官网下载jdk
# https://www.wendangku.net/doc/452050543.html,/technetwork/java/javase/downloads/jdk8-downloads-2133151.html
rpm -ih jdk-8u102-linux-x64.rpm
java -version
javac -version
#安装不配置环境变量，可能出现某些类找不到
echo 'export JAVA_HOME=/usr/java/jdk1.8.0_102/' >>/etc/profile
echo 'export JRE_HOME=/usr/java/jdk1.8.0_102/jre' >>/etc/profile
echo 'PATH=$JAVA_HOME/bin:$PATH' >>/etc/profile
tail -3 /etc/profile
source /etc/profile
二、sonarqube5.6 安装
#1.下载安装包
#https://www.wendangku.net/doc/452050543.html,/downloads/
wget https://https://www.wendangku.net/doc/452050543.html,/Distribution/sonarqube/sonarqube-5.6.3.zip
mkdir -p /disk1/app/sonar
unzip sonarqube-5.6.3.zip -d /disk1/app/sonar
ll /disk1/app/sonar
vim /etc/init.d/sonar
#!/bin/sh
#
# rc file for SonarQube
#
# chkconfig: 345 96 10
# description: SonarQube system (https://www.wendangku.net/doc/452050543.html,)
#
### BEGIN INIT INFO
# Provides: sonar
# Required-Start: $network
# Required-Stop: $network
# Default-Start: 3 4 5
# Default-Stop: 0 1 2 6
# Short-Description: SonarQube system (https://www.wendangku.net/doc/452050543.html,)
# Description: SonarQube system (https://www.wendangku.net/doc/452050543.html,)
### END INIT INFO
/usr/bin/sonar $*
chmod +x /etc/init.d/sonar
ln -s /disk1/app/sonar/sonarqube-5.6.3/bin/linux-x86-64/sonar.sh /usr/bin/sonar
chkconfig sonar on
#2.创建数据库和账号
mysql -uroot -p123456
#创建数据库
CREATE DATABASE sonar CHARACTER SET utf8 COLLATE utf8_general_ci;
GRANT ALL PRIVILEGES ON sonar.* TO 'sonar'@'localhost' IDENTIFIED BY '123456' WITH GRANT OPTION;
GRANT ALL PRIVILEGES ON sonar.* TO 'sonar'@'%' IDENTIFIED BY '123456' WITH GRANT OPTION; FLUSH PRIVILEGES;
\q
#验证一下账号和密码
mysql -usonar -p123456 -e " show databases;"
#3.配置sonar参数
#参考https://www.wendangku.net/doc/452050543.html,/display/SONAR/Installing+the+Server
cd /disk1/app/sonar/sonarqube-5.6.3/
cp conf/sonar.properties conf/sonar.properties.orig
sed -i 's/#https://www.wendangku.net/doc/452050543.html,ername=/https://www.wendangku.net/doc/452050543.html,ername=sonar/g' conf/sonar.properties
sed -i 's/#sonar.jdbc.password=/sonar.jdbc.password=123456/g' conf/sonar.properties
sed -i 's/#sonar.web.port=9000/sonar.web.port=9000/g' conf/sonar.properties
egrep "https://www.wendangku.net/doc/452050543.html,ername|sonar.jdbc.password|sonar.web.port=9000" conf/sonar.properties #修改配置
vim conf/sonar.properties +23
14 https://www.wendangku.net/doc/452050543.html,ername=sonar
15 sonar.jdbc.password=123456
23
sonar.jdbc.url=jdbc:mysql://localhost:3306/sonar?useUnicode=true&characterEncoding=utf8&rewriteBatchedStat em ents=true&useConfigs=maxPerformanc
105 sonar.web.port=9000
61 sonar.jdbc.maxActive=10
65 sonar.jdbc.maxIdle=5
69 sonar.jdbc.minIdle=2
74 sonar.jdbc.maxWait=5000
76 sonar.jdbc.minEvictableIdleTimeMillis=600000
77 sonar.jdbc.timeBetweenEvictionRunsMillis=30000
#4.安装SonarQube Scanner
cd /disk1/tools/
https://www.wendangku.net/doc/452050543.html,/display/SCAN/Analyzing+with+SonarQube+Scanner
unzip sonar-scanner-2.8.zip -d /disk1/app/sonar
ln -s /disk1/app/sonar/sonar-scanner-2.8/bin/sonar-scanner /usr/bin/sonar-scanner
#修改配置
cd /disk1/app/sonar/sonar-scanner-2.8/conf/
cp sonar-scanner.properties sonar-scanner.properties.orig
vim sonar-scanner.properties
11 https://www.wendangku.net/doc/452050543.html,ername=sonar
12 sonar.jdbc.password=123456
18 sonar.jdbc.url=jdbc:mysql://localhost:3306/sonar?useUnicode=true&characterEncoding=utf8
#5.安装SonarQube runner
#https://www.wendangku.net/doc/452050543.html,/display/SONARQUBE51/Installing+and+Configuring+SonarQube+Runner
cd /disk1/tools/
wget https://www.wendangku.net/doc/452050543.html,/maven2/org/codehaus/sonar/runner/sonar-runner-dist/2.4/sonar-runner-dist-2.4.zip
unzip sonar-runner-dist-2.4.zip -d /disk1/app/sonar
ll /disk1/app/sonar
ln -s /disk1/app/sonar/sonar-runner-2.4/bin/sonar-runner /usr/bin/sonar-runner
cd /disk1/app/sonar/sonar-runner-2.4/conf/
cp sonar-runner.properties sonar-runner.properties.orig
vim sonar-runner.properties
11 sonar.jdbc.url=jdbc:mysql://localhost:3306/sonar?useUnicode=true&characterEncoding=utf8
20 https://www.wendangku.net/doc/452050543.html,ername=sonar
21 sonar.jdbc.password=123456
vim /etc/profile.d/sonar.sh
#-------------添加如下代码-----
#!/bin/bash
SONAR_HOME=/disk1/app/sonar/sonarqube-5.6.3
SONAR_RUNNER_HOME=/disk1/app/sonar/sonar-runner-2.4
PATH=$SONAR_RUNNER_HOME/bin:$PATH
export SONAR_HOME
export SONAR_RUNNER_HOME
export PATH
#------------添加代码结束----------
source /etc/profile.d/sonar.sh
#6.启动sonar
/etc/init.d/sonar start stop
/etc/init.d/sonar start restart
/etc/init.d/sonar start start
/etc/init.d/sonar start status
#需要等2-3分钟，端口号才起来
netstat -atnlp|grep 9000
ps -ef |grep sonar
#登陆:用浏览器登陆，需要运行1分钟这样才会出界面
http://192.168.0.75:9000/ 默认密码是admin admin
#点右上角的log in，默认用户名和密码是admin/admin
#去更新中心可以安装中文包
#搜索chinese
#安装php支持
#安装Android
#安装成功后，重启sonarqube服务，再次访问http://ip:9000/，即可看到中文界面
/etc/init.d/sonar restart
cd /disk1/app/sonar/sonarqube-5.6.3/extensions/plugins/
wget https://www.wendangku.net/doc/452050543.html,/content/groups/public_release/com/synaptix/sonar-gitlab-plugin/1.7.0/sonar-gitlab-plugin-1.7.0.jar #重启
/etc/init.d/sonar restart
三、手工测试
我们用sonar-runner手工测试一下,具体使用说明网见如下链接：
https://www.wendangku.net/doc/452050543.html,/display/SONARQUBE51/Analyzing+with+SonarQube+Runner 随便拿一个之前弄过的php项目，把它复制到根目录下，我的情况下如：
网站index.php目录路径为：/disk1/www/information_server/backend/web，测试操作如下：cd /disk1/www/information_server
vim sonar-project.properties
#添加如一内容：
sonar.projectKey=my:phpcook
sonar.projectName=PHP cook sonar test
sonar.projectVersion=1.0
#这里是php文件放的地方，这里表示根目录下的backend/web目录
sonar.sources=backend/web
# Language
https://www.wendangku.net/doc/452050543.html,nguage=php
sonar.dynamicAnalysis=false
# Encoding of the source files
sonar.sourceEncoding=UTF-8
#在当前目录下运行
sonar-runner
#完成后用浏览器登陆sonar，会如下图所示：
四、Jenkins安装
#1.jenkins安装
#1.yum安装，https://www.wendangku.net/doc/452050543.html,/redhat/
sudo wget -O /etc/yum.repos.d/jenkins.repo http://pkg.jenkins.io/redhat/jenkins.repo
sudo rpm --import http://pkg.jenkins.io/redhat/jenkins.io.key
yum install jenkins
用yum安装太慢我直接去目录下载包安装，目前最新版本为jenkins-2.24-1.1.noarch.rpm rpm --import http://pkg.jenkins.io/redhat/jenkins.io.key
rpm -ih jenkins-2.24-1.1.noarch.rpm
#修改目录配置文件，修改家目录和端口号（和gitlab有冲突）
mkdir -p /disk1/app/jenkins
chown jenkins.jenkins -R /disk1/app/jenkins
vim /etc/sysconfig/jenkins
10 #JENKINS_HOME="/var/lib/jenkins"
11 JENKINS_HOME="/disk1/app/jenkins"
57 #JENKINS_PORT="8080"
58 JENKINS_PORT="9080"
/etc/init.d/jenkins start
/usr/lib/jenkins/：jenkins安装目录，WAR包会放在这里。
/etc/sysconfig/jenkins：jenkins配置文件，“端口”，“JENKINS_HOME”等都可以在这里配置。Starting Jenkins -bash: /usr/bin/java: No such file or directory
时就需要“vi /etc/init.d/jenkins”，把java路径加上，一般不用加也行，如下：
#打开浏览器输入：http://192.168.0.75:9080
选择“Install suggested plugins”安装默认的插件，下面Jenkins就会自己去下载相关的插件进行安装。
创建超级管理员账号：我这里写的是hua 123456
#2. Jenkins插件安装
登陆Jenkins-->系统管理-->管理插件
要让Jenkins可以自动build git repo中的代码，需要安装GIT Client Plugin和GIT Plugin。
要想Jenkins可以收到Gitlab发来的hook从而自动build，需要安装Gitlab Hook Plugin。
要让Jenkins可以在build完成之后根据TAP（test anything protocol）文件生成graph，需要安装TAP Plugin。SonarQube：SonarQube Plugin、Sonargraph Integration Jenkins Plugin、Sonargraph Plugin
实用插件：
#如果插件安装不上请请检查hostname和hosts中名字是否一致，重启服务器再试
iOS专用：Xcode integration
Android专用：Gradle plugin (默认已经安装）
Gitlab插件：GitLab Plugin 和Gitlab Hook Plugin、GitLab Logo Plugin
Git插件：Git plugin、Git client plugin
sonar插件：SonarQube Plugin、Sonargraph Integration Jenkins Plugin、Sonargraph Plugin
---------------------------我只安装以上的软件-----------------------------------------------------------------
其它可选：
jdk：JDK Parameter Plugin
php插件：PHP Plugin
GitBuckit插件：GitBuckit plugin
签名证书管理插件: Credentials Plugin 和Keychains and Provisioning Profiles Management
FTP插件: Publish over FTP
脚本插件: Post-Build Script Plug-in
修改Build名称/描述(二维码)：build-name-setter / description setter plugin
获取仓库提交的commit log：Git Changelog Plugin
自定义全局变量: Environment Injector Plugin
自定义邮件插件：Email Extension Plugin
获取当前登录用户信息：build-user-vars-plugin
显示代码测试覆盖率报表：Cobertura Plugin
来展示生成的单元测试报表，支持一切单测框架，如junit、nosetests等：Junit Plugin 其它：GIT plugin / SSH Credentials Plugin
#2. Jenkins集成Sonar进行代码质量管理
#1.设置sonar中token
首先用admin用户登陆sonarQube，[配置]-->[权限] -->[用户]
得到用户是admin，token号是：5d041bf051cef3af59d89e2935155a181765d090 #2.Jenkins安装Sonar插件，然后点[系统管理] -> [系统设置]配置Sonar，设置完保存
#3. 点[系统管理]->[Global Tool Configuration]添加Sonar Scanner扫描器
3.配置gitlab
gitlab里用建立一个hua账号里面建立一个名字为hua的项目
#2.建立ssh-key
可以用Deploy Key或SSH Keys添加，不过用SSH Keys也可以，能对hua账号下所有用户都能读写，我这里用SSH Keys
项目部署公钥（Deploy Key）允许通过SSH协议以只读的方式访问项目，不需要输入密码，而且数据是使用你上传的公钥加密传输的。与HTTPS协议相比，SSH协议的数据传输效率要更高和稳定些，支持超大项目数据的传输。顾名思义，本功能的用途就在于项目的部署上，只需要一次性添加部署公钥，就可以免去现有HTTPS方式每次输入密码和普通SSH方式对代码有读写权限的麻烦，数据全程加密传输，保证了代码的安全性。
#生成ssh-key
ssh-keygen -t rsa -C "gitlab@vm5"
#我这里修改密钥的名字的默认位置
/var/lib/jenkins/.ssh/id_gitlab_hua
#查看公钥内容
[root@vm5 ~]# cat /var/lib/jenkins/.ssh/id_gitlab_hua.pub
ssh-rsa
AAAAB3NzaC1yc2EAAAABIwAAAQEA0FOZAkVVJbynZxTFRxkHgpAFtFzsesTEtoHHdQznREcl7FCz6SB 7D+s3s1RgZLWfryKqQAm1QTACdRWrNSiQXfTj6+p7+e7DgQLUVYisfTfaSmkYThICQCEw/hG8s1ylh10 v02TSTuEbs3rRFGZ9x2hgnMRVAiSBS+HL2BAa+tapOKDegdhU/C+vWBE6v04RJzSwHW31YLho7DFtu UYqRufcvsctkwzwulnsu7stkBlmF2l2hjFQbVef/sRIbr6+IO386lrgVkivx7tx9slz1Is0eFHOTil+YXj9AMaIco bYI7bmRHNNK3CoZPCg96yv59aUw4MSYhJrnRQOfXr9AQ== gitlab@vm5
#查看私钥内容
cat /var/lib/jenkins/.ssh/id_gitlab_hua
#3.在gitlab添加ssh-key
#4.jenkins配置gitlab #1.用hua账号登陆gitlab
这里的授权账号就是jenkins的token，得知hua账号的token是：oSAnqz9XM6zP_mkci4jH
#2.在jenkins配置gitlab
[系统管理]-->[系统设置]里"Gitlab"选项
#5.测试（连gitlab一起配置）#登陆jenkins新建一个任务
编写高质量代码--Web前端开发修炼之道笔记
第一章从网站重构说起 打造高质量的前端代码，提高代码的可维护性——精简、重用、有序。 第二章团队合作 精一行，通十行。 增加代码可读性——注释。 重用性需提高，分为公共组件与私有组件，代码模块化。公共组件不能轻易修改，因为影响大，所以一般只提供“读”的权限。 磨刀不误砍柴工——前期的构思很重要。构思的主要内容包括规范的制定、公共组件的设计和复杂功能的技术方案等。一般来说，前期构思占整个项目30%~60%的时间都算是正常的。 第三章高质量的HTML
CSS只是web标准的一部分，在HTML、CSS、JS三大元素中，HTML才是最重要的，结构才是重点，样式是用来修饰结构的。正确的做法是，先确定HTML，确定语义的标签，再来选用合适的CSS。 判断标签语义是否良好的简单方法：去掉样式，看网页结构是否组织良好有序，是否仍然有很好的可读性。语义良好的网页去掉样式后结构依然很清晰。 “CSS裸体日”，2006.04.05第一届，从第三届开始改为4月9日。（设立目的就是为了提醒大家用合适的HTML标签的重要性） 一个语义良好的页面，h标签应该是完整有序没有断层的，也就是说要按照h1、h2、h3、h4这样的次序排下来，不要出现类似h1、h3、h4，漏掉h2的情况。 当页面内标签无法满足设计需要时，才会适当添加div和span等五语义标签来辅助实现。 第四章高质量的CSS 组织CSS的方法：base.css+common.css+page.css，在一般情况下任何一个网页的最终表现都是由这三者共同完成的，这三者不是并列结构，而是层叠结构。
base.css一般包括cssreset和通用原子类，比如设置一些常用的清除浮动、宽度、高度等class。可以参考一些前端框架，例如YUI、bootstrap等等。 拆分模块技巧：模块与模块之间尽量不要包含相同的部分，如果有相同部分，应将它们提取出来，拆分成一个独立的模块。模块应在保证数量尽可能少的原则下，做到尽可能简单，以提高重用性。 团队开发人员多，可在classname前加前缀。 如果不确定模块的上下margin特别稳定，最好不要将它们写到模块的类里，而是使用类的组合，单独为上下margin挂用于边距的原子类（例如mt10、mb20）。模块最好不用混用margin-top和margin-bottom，统一使用margin-top或margin-bottom。 低权重原则——避免滥用子选择器 普通标签权重1，class权重10，id权重100 为了保证样式容易被覆盖，提高可维护性，CSS选择符需保证权重尽可能低。 CSS sprite的最大好处是减少HTTP请求数，减轻服务器的压力，但它却需要付出“降低开发效率”和“增大维护难度”的代价。对于流量并不大的网站来说，CSS sprite带来的好处并不明显，而它付出的代价却很大，其实并不划算。所以是否使用CSS sprite主要取决于网站流量。 编码风格：推荐一行书写，能减少文件大小。（因为调试工具多，所以忽略易读性）Hack： A标签问题：
施工现场质量管理检查记录最新
施工现场质量管理检查记录 附件 *******项目部 **年**月
目录 一、建筑工程质量管理规定 二、质量控制“三检一交”制度 三、对项目部绩效考核办法 四、施工图纸会审和自审制度 五、建筑工程施工组织管理规定 六、建筑施工组织设计编制实施管理规定 七、建筑施工技术交底编制管理规定 八、建筑材料管理规定 九、施工机械设备管理规定 十、管理人员岗位证书 十一、特种工证件
一、建筑工程质量管理规定 在工程质量管理中，要坚决贯彻和体现“百年大计、质量第一”的方针，坚持“高标准、严要求、树品牌”和“让用户满意、对社会负责”的经营理念。 第一条质量工作目标为：所承建的建筑工程，全部达到国家规范要求的合格标准，并一次性验收合格率达100%，其中主体结构工程优良率达80%以上；单位工程竣工验收优良率达60%以上。 第二条集团公司质量管理组织体系，按职责和分工实行分层负责 1、建立以生产副总经理、总工程师为首，工程部牵头的建筑工程质量管理领导组，负责全公司建筑工程质量管理的实施方案并指导监督和检查考评比。 2、建立以分公司、项目经理、项目总工（技术负责人）为主的工程质量管理机构，对建筑工程质量进行全方位管理与监控。 3、各作业班组都应有班组质量监管人员对所承担的施工任务负责质量监管。 4、凡专职工程质量管理人员应具备相应的技术能力，并取得相应的技术职称和岗位证件。 第三条在工程质量管理中必须做到： 1、正确使用施工图纸设计文件、验收规范及施工工艺标准、认真编制施工作业指导书，在施工中各工艺实行样板引路。 2、一万平方米以下的建筑工程应配备一名专职质量员，一至三万平方米的建筑工程应配备两名专职质量员，三万平方米以上的建筑工程应成立质量小组，且不少于3名专职质量员。
敏捷开发中高质量Java代码开发实践
本文将介绍在敏捷开发过程中如何通过采取一系列的步骤来保证和提高整个项目的代码质量，阐述了每一步可以利用的工具和最佳实践，从而使开发过程更加规范化，成就高质量的代码。 概述 Java项目开发过程中，由于开发人员的经验、代码风格各不相同，以及缺乏统一的标准和管理流程，往往导致整个项目的代码质量较差，难于维护，需要较大的测试投入和周期等问题。这些问题在一个项目组初建、需求和设计均具有不完全可预期性和完备性的全新项目中将尤为突出。本文将结合敏捷开发周期短，变化快等特点，介绍如何通过在开发过程中采取一系列步骤来保证和提高整个开发团队的代码质量，并阐述了每一步可以利用的工具和最佳实践，从而使开发过程更加规范化，成就高质量的代码，减少测试的投入，并促进整个团队的技能提高，最终提高开发效率和质量。 如图1所示，敏捷开发过程经历需求调研，用例分析和用例分解，进入开发迭代阶段。在每个迭代过程中，可以采用以下五个步骤来保证和提高整个项目的代码质量：统一编码规范、代码样式；静态代码分析（static code review）；单元测试；持续集成；代码评审和重构（Review&Refactor）。下文将针对每个步骤和其所使用的工具、方法进行详细描述。 图 1.敏捷开发中的Java代码质量保证步骤 步骤一：统一编码规范、代码样式 规范统一的编码会增加项目代码的可读性和可维护性，但实际情况往往是项目组内的Java代码开发
人员的编码风格常常各不相同，这可能是由于不同的经验习惯或者缺乏编码规范方面的学习造成的。这样一来，其他项目成员或者维护人员在阅读项目代码时就需要花费更多的时间来理解代码作者的意图，所以制定并采取统一的编码规范就显得很重要。编码规范主要应包含以下几个方面： ?一般规则和格式规范。例如代码缩进、程序块规范、每行最大代码长度等。 ?命名规则。例如包名、类名、变量、方法、接口、参数等命名规范 ?文档规范。例如类文件头声明、类注释、成员变量和方法注释等规范。 ?编程规范。例如异常、并发、多线程等方面的处理方式。 ?其他规范。例如日志格式、属性文件格式，返回值和消息格式。 项目的编码规范可以参考已有的一些Java编程规范书籍和其他相关资料并结合项目的本身来制定，可供参考的书籍有《Java编程风格》（英文书名为：The Elements of Java Style）。编码规范要形成文档，而且要简洁明了，并组织项目成员一起学习，确保所有成员正确理解所有条目。 一旦编码规范确定，就可以利用Eclipse自身提供的功能来控制代码样式和格式。具体做法是，点击Eclipse的Windows->Preference菜单项，在打开的Preferences对话框的左侧栏中找到Java节点下的子项Code Style（如图2），该项和它的子项允许您对Java代码的样式进行控制。 图 2.Eclipse代码样式设置窗口
施工现场质量管理检查记录.
现场质量管理制度 现场质量管理制度反映施工单位的现场管理水平，是质量管理体系的一部分，必须有具体的管理制度，检查时应重点检查下列内容： 一、技术交底制度 项目部应坚持以技术进步来保证施工质量的原则，项目技术部编制有针对性的施工组织设计，积极采用新工艺、新技术，针对特殊工序要贬值有针对性的作业指导书或施工方案。每个工种、每道工序施工期前要组织进行各级技术交底，工长对各个班组长的技术交底，班组长对操作工人的交底。 二、材料进场检验制度 项目部应建立合格材料供应商的档案，并从列入的供应商中采购材料、构配件和设备的质量承担相应的责任。材料进场必须进行材料产品外观质量的检查验收和材质复核检验，同时要检查厂家或供应商提供的“质保书”、“准用证”、“检测报告”、“出厂合格证明”等有关文件，不合格的材料不得使用在工程上。 三、样板引路制度 施工操作时要注意工序的优化、工艺的改进和工序的标准化操作，通过不断探索，积累必要的管理和操作经验，提高工序的操作水平、操作质量。每个分项工程或工种（特别是量大面广的分项工序）都要在开始大面积操作前做出示范样板，包括样板墙、 样板间、样板件等，把标准实物化，统一操作要求，明确质量目 标，以及向用户做出承诺。 四、施工挂牌制度 主要工种如钢筋、混凝土、模板、砌体、抹灰等施工过程中要在现场实行挂牌制度，注明管理者、操作者、施工日期，并做出相应的图文记录，作为重要的施工档案保存。因施工现场不按规范、程序施工而造成质量事故的要追究有关人员的责任。 五、施工过程三检制度和质量否决制度 1、实行自检、互检、交接检制度，自检要做文字记录。 2、隐蔽工程要有工长组织，项目负责人、质量检查员、班组长检查验收，并 做成较详细的文字记录。自检合格后报现场监理工程师和甲方以及有关单位共同验收，签字确认。 3、在三检过程中发现不合格的分项、分部工程，就不准进入下道工序的施工， 否则要追究工长和项目经理的责任。 六、成品保护和工程质量评定 1、应当像重视施工操作一样重视成品保护。项目管理人员应合理安排施工工 序，减少工序交叉作业。上下工序之间应做好交接工序、并做好记录。 2、如下道工序的施工可能对上道工序的成品造成影响，应征得上道工序操作 人员及管理人员的同意，并避免破坏和污染，否则造成的损失由下道工序操作者及管理人员负责。 3、施工企业应按国家有关标准、规范进行工程质量评定验收，即作为工程质 量的记录，也作为工程量核算及操作人员考核的依据。 七、持证上岗制度
编写高质量Java代码
敏捷开发中编写高质量Java代码 敏捷开发的理念已经流行了很长的时间，在敏捷开发中的开发迭代阶段中，我们可以通过五个步骤，来有效的提高整个项目的代码质量。 Java项目开发过程中，由于开发人员的经验、Java代码编写习惯，以及缺乏统一的标准和管理流程，往往导致整个项目的代码质量较差，难于维护，需要较大的测试投入和周期等问题。这些问题在一个项目组初建、需求和设计均具有不完全可预期性和完备性的全新项目中将尤为突出。 如图1所示，敏捷开发过程经历需求调研，用例分析和用例分解，进入开发迭代阶段。在每个迭代过程中，可以采用以下步骤来保证和提高整个项目的代码质量：统一编码规范、代码样式;静态代码分析(staticcodereview);单元测试;持续集成;代码评审和重构 (Revi ew&Refactor)。下文将针对每个步骤和其所使用的工具、方法进行详细描述。 图1.敏捷开发中的Java代码质量保证步骤 步骤一：统一编码规范、代码样式 规范统一的编码会增加项目代码的可读性和可维护性，但实际情况往往是项目组内的Java代码开发人员的编码风格常常各不相同，这可能是由于不同的经验习惯或者缺乏编码规范方面的学习造成的。这样一来，其他项目成员或者维护人员在阅读项目代码时就需要花费更多的时间来理解代码作者的意图，所以制定并采取统一的编码规范就显得很重要。编码规范主要应包含以下几个方面： ◆一般规则和格式规范。例如代码缩进、程序块规范、每行最大代码长度等。 ◆命名规则。例如包名、类名、变量、方法、接口、参数等命名规范 ◆文档规范。例如类文件头声明、类注释、成员变量和方法注释等规范。 ◆编程规范。例如异常、并发、多线程等方面的处理方式。 ◆其他规范。例如日志格式、属性文件格式，返回值和消息格式。
我编写过的最漂亮的代码
第3章我编写过的最漂亮的代码 Jon Bentley 我曾经听一位大师级的程序员这样称赞到，“我通过删除代码来实现功能的提升。”而法国著名作家兼飞行家Antoine de Saint-Exupéry的说法则更具代表性，“只有在不仅没有任何功能可以添加，而且也没有任何功能可以删除的情况下，设计师才能够认为自己的工作已臻完美。”某些时候，在软件中根本就不存在最漂亮的代码，最漂亮的函数，或者最漂亮的程序。 当然，我们很难对不存在的事物进行讨论。本章将对经典Quicksort（快速排序）算法的运行时间进行全面的分析，并试图通过这个分析来说明上述观点。在第一节中，我将首先根据我自己的观点来回顾一下Quicksort，并为后面的内容打下基础。第二节的内容将是本章的重点部分。我们将首先在程序中增加一个计数器，然后通过不断地修改，从而使程序的代码变得越来越短，但程序的功能却会变得越来越强，最终的结果是只需要几行代码就可以使算法的运行时间达到平均水平。在第三节将对前面的技术进行小结，并对二分搜索树的运行开销进行简单的分析。最后的两节将给出学完本章得到的一些启示，这将有助于你在今后写出更为优雅的程序。 3.1 我编写过的最漂亮代码 当Greg Wilson最初告诉我本书的编写计划时，我曾自问编写过的最漂亮的代码是什么。这个有趣的问题在我脑海里盘旋了大半天，然后我发现答案其实很简单：Quicksort算法。但遗憾的是，根据不同的表达方式，这个问题有着三种不同的答案。 当我撰写关于分治（divide-and-conquer）算法的论文时，我发现 C.A.R. Hoare的Quicksort算法（“Quicksort”，Computer Journal 5）无疑是各种Quicksort算法的鼻祖。这是一种解决基本问题的漂亮算法，可以用优雅的代码实现。我很喜欢这个算法，但我总是无法弄明白算法中最内层的循环。我曾经花两天的时间来调试一个使用了这个循环的复杂程序，并且几年以来，当我需要完成类似的任务时，我会很小心地复制这段代码。虽然这段代码能够解决我所遇到的问题，但我却并没有真正地理解它。 我后来从Nico Lomuto那里学到了一种优雅的划分（partitioning）模式，并且最终编写出了我能够理解，甚至能够证明的Quicksort算法。William Strunk Jr.针对英语所提出的“良好的写作风格即为简练”这条经验同样适用于代码的编写，因此我遵循了他的建议，“省略不必要的字词”（来自《The Elements of Style》一书）。我最终将大约40行左右的代码缩减为十几行的代码。因此，如果要回答“你曾编写过的最漂亮代码是什么？”这个问题，那么我的答案就是：在我编写的《Programming Pearls, Second Edition》(Addison-Wesley)一书中给出的Quichsort算法。在示例3-1中给出了用C语言编写的Quicksort函数。我们在接下来的章节中将进一步地研究和改善这个函数。 【示例】 3-1 Quicksort函数 void quicksort(int l, int u) { int i, m; if (l >= u) return;
施工现场质量管理检查记录(完整版)
施工现场质量管理检查记录 表A.0.1 开工日期：2010-10-5
施工现场自检、互检、交接检查制度 1、“三检”是确保施工过程中工作质量所采取的一个重要手段，每个班组，施工员必须严格执行。 2、生产工人对自已一天所完成的产品，必须按质量验收标准进行检查验收。 3、在施工过程中或以完成的施工部位分项工程中，有班组长组织相互对各自完成的工作量进行互检，按施工规范要求相互监督工程质量。 4、由一个施工班组转交另一个施工班组施工时，接收双方应进行一次全面检查，发现不合格的应重新返工，接收班组不得自行自理和隐蔽等。 5、质检科接到交接检发现的质量问题时，应及时处理，不得扯皮，拖拉，接收班组应在前班组处理并经验评合格后，方可进行下道工序施工。 6、施工过程中凡末执行“三检”制度的班组，个人，接收班组和个人有权拒绝下道工序施工，公司将给予支持，并对末执行者给予批评和处罚。 7、交接手续实行表格化，详细记录，前班组产品的质量情况、交接时间，接收人对上道工序意见，存在问题解决时间，下道工序应注意事项，交接双方和施工员共同签字，并整理归档。 宣城广恒公司
分项、分部、单位工程综合评定验收制度 1、严格按照国家规定的检验评定标准评定 2、各施工员应准确地划分各分部、分项,按要求进行,不得缺项,在施工前,绘制技术资料系统图. 3、各分项、分部工程质量评定,应在班组自检合格的基础上,交公司专职质检员进行核定,末经核定的分项自检表,作为所在分部的不合格分项,必须重新检验核定。 4、各分项工程，必须在完工后立既由施工员会同工长，班组长进行验收评定，合格后交专职质检员核定，不准事后补充，凡事后补充分项自检表，质检员有权拒绝核定。 5、工程每一分部、分项完工后，施工员通知质检员现场进行核定，质检员不得推诿，否则有质检员负责。 6、装饰、楼地面、屋面、门窗、水电气分部工作，由质检员、工程负责人、质检科长共同核定。 7、地基与基础、主体分部工程由工程负责人，质检科长和技术负责人共同核定。 8、质量保证资料，由单位工程技术负责人检查后，交公司技术负责人核定，单位工程观感质量评定，单位工程负责人和施工技术员检查后，由质检科长参与，公司技术负责人核定。 9、单位工程，由单位工程负责人自检后，由公司经理和公司技术负责人共同签字负责，该项活动由公司技术负责人组织质检科配合。
敏捷开发中编写高质量Java代码+
敏捷开发中编写高质量Java代码收藏 敏捷开发的理念已经流行了很长的时间，在敏捷开发中的开发迭代阶段中，我们可以通过五个步骤，来有效的提高整个项目的代码质量。 Java项目开发过程中，由于开发人员的经验、Java代码编写习惯，以及缺乏统一的标准和管理流程，往往导致整个项目的代码质量较差，难于维护，需要较大的测试投入和周期等问题。这些问题在一个项目组初建、需求和设计均具有不完全可预期性和完备性的全新项目中将尤为突出。 如图1所示，敏捷开发过程经历需求调研，用例分析和用例分解，进入开发迭代阶段。在每个迭代过程中，可以采用以下步骤来保证和提高整个项目的代码质量：统一编码规范、代码样式;静态代码分析(staticcodereview);单元测试;持续集成;代码评审和重构(Review&Refact or)。下文将针对每个步骤和其所使用的工具、方法进行详细描述。 图1.敏捷开发中的Java代码质量保证步骤
步骤一：统一编码规范、代码样式 规范统一的编码会增加项目代码的可读性和可维护性，但实际情况往往是项目组内的Java代码开发人员的编码风格常常各不相同，这可能是由于不同的经验习惯或者缺乏编码规范方面的学习造成的。这样一来，其他项目成员或者维护人员在阅读项目代码时就需要花费更多的时间来理解代码作者的意图，所以制定并采取统一的编码规范就显得很重要。编码规范主要应包含以下几个方面： ◆一般规则和格式规范。例如代码缩进、程序块规范、每行最大代码长度等。 ◆命名规则。例如包名、类名、变量、方法、接口、参数等命名规范 ◆文档规范。例如类文件头声明、类注释、成员变量和方法注释等规范。 ◆编程规范。例如异常、并发、多线程等方面的处理方式。 ◆其他规范。例如日志格式、属性文件格式，返回值和消息格式。 项目的编码规范可以参考已有的一些Java编程规范书籍和其他相关资料并结合项目的本身来制定，可供参考的书籍有《Java编程风格》(英文书名为：TheElementsofJavaStyle)。编码规范要形成文档，而且要简洁明了，并组织项目成员一起学习，确保所有成员正确理解所有条目。 一旦编码规范确定，就可以利用Eclipse自身提供的功能来控制代码样式和格式。具体做法是，点击Eclipse的Windows->Preference菜单项，在打开的Preferences对话框的左侧栏中找到Java节点下的子项CodeStyle(如图2)，该项和它的子项允许您对Java代码的样式进行控制。
编写高质量的代码,从命名入手
编写高质量的代码，从命名入手 笔者从事开发多年，有这样一种感觉，查看一些开源项目，如Spring、Apache Common等源码是一件赏心悦目的事情，究其原因，无外两点：1）代码质量非常高；2）命名特别规范（这可能跟老外的英语水平有关）。 要写高质量的代码，不是一件容易的事，需要长年累月的锻炼，是一个量变到质变的过程，但要写好命名，只需要有比较好的英语语法基础和一种自我意识即可轻松达到。本博文将会结合本人的开发经验，总结出若干命名规则，这些命名规则纯属个人的使用习惯，不代表是一种理想的规则，在这里列举出来，供大家交流讨论。 1.切忌使用没有任何意义的英语字母进行命名 for(int i=0; i<10; i++) { ... } 这是在很多教Java基本语法的书上常见的代码片断，作为教学材料，这样写无可厚非，但作为真正的代码编写，程序员必须要养成良好的习惯，不要使用这种没有任何含义的命名方式，这里可以使用“index”。 2.切忌使用拼音，甚至是拼音首字母组合 cishu =5; // 循环的次数 zzje = 1000.00// 转账金额 笔者在做代码检查的时候，无数次遇到过这样的命名，使人哭笑不得 3.要使用英文，而且要使用准确的英语，无论是拼写还是语法 名词单数，必须使用单数英文，如Account、Customer。 对于数组，列表等对象集合的命名，必须使用复数，而且最好按照英文的语法基础知识使用准确的复数形式，如List
如何提高代码质量
我们评价高质量代码有三要素：可读性、可维护性、可变更性。我们的代码要一个都不能少地达到了这三要素的要求才能算高质量的代码。 今天这堂培训课讲什么呢？我既不讲Spring，也不讲Hibernate，更不讲Ext，我不讲任何一个具体的技术。我们抛开任何具体的技术，来谈谈如何提高代码质量。如何提高代码质量，相信不仅是在座所有人苦恼的事情，也是所有软件项目苦恼的事情。如何提高代码质量呢，我认为我们首先要理解什么是高质量的代码。 高质量代码的三要素 我们评价高质量代码有三要素：可读性、可维护性、可变更性。我们的代码要一个都不能少地达到了这三要素的要求才能算高质量的代码。 1. 可读性强 一提到可读性似乎有一些老生常谈的味道，但令人沮丧的是，虽然大家一而再，再而三地强调可读性，但我们的代码在可读性方面依然做得非常糟糕。由于工作的需要，我常常需要去阅读他人的代码，维护他人设计的模块。每当我看到大段大段、密密麻麻的代码，而且还没有任何的注释时常常感慨不已，深深体会到了这项工作的重要。由于分工的需要，我们写的代码难免需要别人去阅读和维护的。而对于许多程序员来说，他们很少去阅读和维护别人的代码。正因为如此，他们很少关注代码的可读性，也对如何提高代码的可读性缺乏切身体会。有时即使为代码编写了注释，也常常是注释语言晦涩难懂形同天书，令阅读者反复斟酌依然不明其意。针对以上问题，我给大家以下建议： 1）不要编写大段的代码 如果你有阅读他人代码的经验，当你看到别人写的大段大段的代码，而且还不怎么带注释，你是怎样的感觉，是不是“嗡”地一声头大。各种各样的功能纠缠在一个方法中，各种变量来回调用，相信任何人多不会认为它是高质量的代码，但却频繁地出现在我们编写的程序了。如果现在你再回顾自己写过的代码，你会发现，稍微编写一个复杂的功能，几百行的代码就出去了。一些比较好的办法就是分段。将大段的代码经过整理，分为功能相对独立的一段又一段，并且在每段的前端编写一段注释。这样的编写，比前面那些杂乱无章的大段代码确实进步了不少，但它们在功能独立性、可复用性、可维护性方面依然不尽人意。从另一个比较专业的评价标准来说，它没有实现低耦合、高内聚。我给大家的建议是，将这些相对独立的段落另外封装成一个又一个的函数。
高质量编程指南
高质量C++/C 编程指南 文件标识： 当前版本： 1.0 作 者：林锐 博士 文件状态 [ ] 草稿文件 [√] 正式文件 [ ] 更改正式文件 完成日期： 2001年7月24日
版本历史 版本/状态作者参与者起止日期备注 V 0.9 草稿文件林锐 2001-7-1至 2001-7-18 林锐起草 V 1.0 正式文件林锐 2001-7-18至 2001-7-24 朱洪海审查V 0.9， 林锐修正草稿中的错误
目录 前言 (6) 第1章文件结构 (11) 1.1版权和版本的声明 (11) 1.2头文件的结构 (12) 1.3定义文件的结构 (13) 1.4头文件的作用 (13) 1.5目录结构 (14) 第2章程序的版式 (15) 2.1空行 (15) 2.2代码行 (16) 2.3代码行内的空格 (17) 2.4对齐 (18) 2.5长行拆分 (19) 2.6修饰符的位置 (19) 2.7注释 (20) 2.8类的版式 (21) 第3章命名规则 (22) 3.1共性规则 (22) 3.2简单的W INDOWS应用程序命名规则 (23) 3.3简单的U NIX应用程序命名规则 (25) 第4章表达式和基本语句 (26) 4.1运算符的优先级 (26) 4.2复合表达式 (27) 4.3 IF 语句 (27) 4.4循环语句的效率 (29) 4.5 FOR 语句的循环控制变量 (30) 4.6 SWITCH语句 (30) 4.7 GOTO语句 (31) 第5章常量 (33) 5.1为什么需要常量 (33) 5.2 CONST 与#DEFINE的比较 (33) 5.3常量定义规则 (33) 5.4类中的常量 (34) 第6章函数设计 (36)
高质量代码三要素
高质量代码的三要素 我们评价高质量代码有三要素：可读性、可维护性、可变更性。我们的代码要一个都不能少地达到了这三要素的要求才能算高质量的代码。 1.可读性强 一提到可读性似乎有一些老生常谈的味道，但令人沮丧的是，虽然大家一而再，再而三地强调可读性，但我们的代码在可读性方面依然做得比较糟糕。每当我看到大段大段、密密麻麻的代码，而且还没有任何的注释时常常感慨不已，深深体会到了这项工作的重要。由于分工的需要，我们写的代码难免需要别人去阅读和维护的。而对于许多程序员来说，他们很少去阅读和维护别人的代码。正因为如此，他们很少关注代码的可读性，也对如何提高代码的可读性缺乏切身体会。有时即使为代码编写了注释，也常常是注释语言晦涩难懂形同天书，令阅读者反复斟酌依然不明其意。针对以上问题，我给大家以下建议： 1）不要编写大段的代码 如果你有阅读他人代码的经验，当你看到别人写的大段大段的代码，而且还不怎么带注释，你是怎样的感觉，是不是“嗡”地一声头大。各种各样的功能纠缠在一个方法中，各种变量来回调用，相信任何人都不会认为它是高质量的代码，但却频繁地出现在我们编写的程序了。如果现在你再回顾自己写过的代码，你会发现，稍微编写一个复杂的功能，几百行的代码就出去了。一些比较好的办法就是分段。将大段的代码经过整理，分为功能相对独立的一段又一段，并且在每段的前端编写一段注释。这样的编写，比前面那些杂乱无章的大段代码确实进步了不少，但它们在功能独立性、可复用性、可维护性方面依然不尽人意。从另一个比较专业的评价标准来说，它没有实现低耦合、高内聚。我给大家的建议是，将这些相对独立的段落另外封装成一个又一个的函数。 许多大师在自己的经典书籍中，都鼓励我们在编写代码的过程中应当养成不断重构的习惯。我们在编写代码的过程中常常要编写一些复杂的功能，起初是写在一个类的一个函数中。随着功能的逐渐展开，我们开始对复杂功能进行归纳整理，整理出了一个又一个的独立功能。这些独立功能有它与其它功能相互交流的输入输出数据。当我们分析到此处时，我们会非常自然地要将这些功能从原函数中分离出来，形成一个又一个独立的函数，供原函数调用。在编写这些函数时，我们应当仔细思考一下，为它们取一个释义名称，并为它们编写注释（后面还将详细讨论这个问题）。另一个需要思考的问题是，这些函数应当放到什么地方。这些函数可能放在原类中，也可能放到其它相应职责的类中，其遵循的原则应当是“职责驱动设计”（后面也将详细描述）。 在编写代码的过程中，通常有两种不同的方式。一种是从下往上编写，也就是按照顺序，每分出去一个函数，都要将这个函数编写完，才回到主程序，继
良好的代码编写风格(二十五条)
[VHDL+Verilog]良好的代码编写风格（二十五条） 良好代码编写风格可以满足信、达、雅的要求。在满足功能和性能目标的前提下，增强代码的可读性、可移植性，首要的工作是在项目开发之前为整个设计团队建立一个命名约定和缩略语清单，以文档的形式记录下来，并要求每位设计人员在代码编写过程中都要严格遵守。良好代码编写风格的通则概括如下：（1）对所有的信号名、变量名和端口名都用小写，这样做是为了和业界的习惯保持一致；对常量名和用户定义的类型用大写； （2）使用有意义的信号名、端口名、函数名和参数名； （3）信号名长度不要太长； （4）对于时钟信号使用clk 作为信号名，如果设计中存在多个时钟，使用clk 作为时钟信号的前缀；（5）对来自同一驱动源的信号在不同的子模块中采用相同的名字，这要求在芯片总体设计时就定义好顶层子模块间连线的名字，端口和连接端口的信号尽可能采用相同的名字； （6）对于低电平有效的信号，应该以一个下划线跟一个小写字母b 或n 表示。注意在同一个设计中要使用同一个小写字母表示低电平有效； （7）对于复位信号使用rst 作为信号名，如果复位信号是低电平有效，建议使用rst_n； （8）当描述多比特总线时，使用一致的定义顺序，对于verilog 建议采用bus_signal[x:0]的表示； （9）尽量遵循业界已经习惯的一些约定。如*_r 表示寄存器输出，*_a 表示异步信号，*_pn 表示多周期路径第n 个周期使用的信号，*_nxt 表示锁存前的信号，*_z 表示三态信号等； （10）在源文件、批处理文件的开始应该包含一个文件头、文件头一般包含的内容如下例所示：文件名，作者，模块的实现功能概述和关键特性描述，文件创建和修改的记录，包括修改时间，修改的内容等；（11）使用适当的注释来解释所有的always 进程、函数、端口定义、信号含义、变量含义或信号组、变量组的意义等。注释应该放在它所注释的代码附近，要求简明扼要，只要足够说明设计意图即可，避免过于复杂； （12）每一行语句独立成行。尽管VHDL 和Verilog 都允许一行可以写多个语句，当时每个语句独立成行可以增加可读性和可维护性。同时保持每行小于或等于72 个字符，这样做都是为了提高代码得可读性；（13）建议采用缩进提高续行和嵌套语句得可读性。缩进一般采用两个空格，如西安交通大学SOC 设计中心2 如果空格太多则在深层嵌套时限制行长。同时缩进避免使用TAB 键，这样可以避免不同机器TAB 键得设置不同限制代码得可移植能力； （14）在RTL 源码的设计中任何元素包括端口、信号、变量、函数、任务、模块等的命名都不能取V erilog 和VHDL 语言的关键字； （15）在进行模块的端口申明时，每行只申明一个端口，并建议采用以下顺序： 输入信号的clk、rst、enables other control signals、data and address signals。然后再申明输出信号的clk、rst、enalbes other control signals、data signals； （16）在例化模块时，使用名字相关的显式映射而不要采用位置相关的映射，这样可以提高代码的可读性和方便debug 连线错误； （17）如果同一段代码需要重复多次，尽可能使用函数，如果有可能，可以将函数通用化，以使得它可以复用。注意，内部函数的定义一般要添加注释，这样可以提高代码的可读性； （18）尽可能使用循环语句和寄存器组来提高源代码的可读性，这样可以有效地减少代码行数； （19）对一些重要的always 语句块定义一个有意义的标号，这样有助于调试。注意标号名不要与信号名、
如何编写高质量的软件技术文档
如何编写高质量的软件文档 摘要： 本文首先阐述了软件文档的重要性；接着描述了软件文档的分类和编写原则、技巧；最后针对我们在编写概要设计说明书中存在的不足，提出了一些指导性原则和大家分享。通过这次分享，希望对大家编写概设等文档时有所帮助。 正文： 我在面试的时候，发现好多公司面试官都不问我写代码的能力如何，JAVA的熟练程度如何，而问我口头和书面表达能力如何，写方案的能力如何，他还说，你写的代码可能只有你的团队或将来维护你程序的人来看；而高层领导，老板和客户他们只看文档的，不会看你的代码的（不是说代码不重要，保证程序运行的正确性和提高代码的运行效率是程序员最基本的能力和职责），刚开始觉着很奇怪，可仔细想想，确实是那样，像我们这种写了多年代码的程序员来说，除了写好代码，其实写得一手好文档尤其重要，文档写不好是程序员向上发展的瓶颈，要提升自己可以先从编写高质量的文档开始。 对于软件开发人员来说，除了保证程序运行的正确性和提高代码的运行效率之外，规范化的文档编制将会对软件的升级、修改、
维护带来极大的方便。因此，开发一个高质量的软件产品，除了完成软件程序本身编制外，还必须提供完整详细的软件文档。 在软件生命周期中，软件文档记载了所有与软件有关的需求、开发、方法等核心技术信息，是保证软件项目开发、运行、维护和管理的重要技术资料。 为了何证软件开发、维护等环节的有效管理以及方便软件技术人员之间进行技术交流，在软件生命周期的每一阶段，都需要编制不同内容的文档。这些文档连同计算机程序及数据一起，构成计算机软件。 软件文档也称做软件文件，是一种重要的软件工程技术资源，例如技术文档、设计文档。软件文档和计算机程序共同构成了能完成特定功能的计算机软件，因此可以说没有文档的软件，不能称其为软件，更不能成为软件产品。 软件文档的规范编制在软件开发工作中占有突出的地位和相当的工作量。高质量地编制、分发、管理和维护文档，及时地变更、修正、扩充和使用文档，对于充分发挥软件产品的效益有着十分重要的意义。 一、软件文档的重要性 软件文档作为计算机软件的重要组成部分，在软件开发人员、软件管理人员、软件维护人员、用户以及计算机之间起着重要的桥梁作用，软件开发人员通过软件文档交流设计思想和设计软件；软件管理人员通过文档了解软件开发项目安
C#代码--编写高质量C#程序
1.1 换行的讲究 (6) 1.1.1 寻找最佳的断行位置 (6) 1.1.2 每行只写一条语句 (8) 1.1.3 分行定义变量 (9) 1.2 避免代码过于拥挤 (10) 1.2.1 使用空行分隔代码块 (10) 1.2.2 使用空格降低代码密度 (14) 1.3 如何缩进 (16) 1.3.1 嵌套或包含关系引起的缩进 (18) 1.3.2 因换行而产生的缩进 (22) 1.3.3 使用空格还是Tab键 (23) 1.4 大括号 (23) 1.4.1 大括号的位置 (23) 1.4.2 空的大括号结构 (24) 1.4.3 仅包含单个语句的结构体 (28) 1.5 保持项目文件的条理性 (30) 1.5.1 解决方案的结构呼应 (30) 1.5.2 代码文件的结构 (31) 1.5.3 使用#region标记 (34) 第2章养成良好的注释习惯 (34) 2.1 何时需要注释 (35) 2.1.1 解释代码的意图 (35) 2.1.2 对局部变量的说明 (36) 2.1.3 充当代码标题 (37) 2.1.4 指出例外情况 (41)
2.1.5 开发提示 (41) 2.2 注释的格式 (42) 2.2.1 单行注释 (43) 2.2.2 多行注释 (44) 2.3 正确使用XML文档注释 (45) 2.3.1 结构与类的XML文档注释 (46) 2.3.2 属性的XML文档注释 (47) 2.3.3 方法的XML文档注释 (49) 2.3.4 构造函数的XML文档注释 (50) 2.3.5 事件的XML文档注释 (51) 2.3.6 枚举类型的XML文档注释 (53) 2.3.7 泛型的XML文档注释 (53) 2.3.8 其他标记 (54) 总的来说，如果多看看MSDN自身的类库参考，你会发现其实XML文档注释最终形成的就是这样的结果。MSDN本身就是一个最好的XML文档注释的范例，我们可以在实践过程中不断地进行模仿和学习。第7章如何使用函数 (57) 7.1 为什么要使用函数 (57) 7.1.1 函数与方法 (57) 7.1.2 代码复用 (59) 7.1.3 隐藏细节 (61) 7.2 函数重载 (65) 7.2.1 重载的语义 (65) 7.2.2 保持核心代码唯一 (70) 7.3 参数的设计 (75) 7.3.1 参数的命名 (75)
编写具有100%可靠性代码的几个技巧
编写具有100%可靠性代码的几个技巧 您编写的代码是不是虽然在仿真器中表现正常，但是在现场却断断续续出错？要不然就是有可能在您使用更高版本的工具链进行编译时，它开始出错。您检查自己的测试平台，并确认测试已经做到100%的完全覆盖，而且所有测试均未出现任何差错，但是问题仍然顽疾难除。虽然设计人员极其重视编码和仿真，但是他们对芯片在FGPA中的内部操作却知之甚少，这是情有可原的。因此，不正确的逻辑综合和时序问题（而非逻辑错误）成为大多数逻辑故障的根源。但是，只要设计人员措施得当，就能轻松编写出能够创建可预测、可靠逻辑的FPGA代码。在FPGA设计过程中，需要在编译阶段进行逻辑综合与相关时序收敛。而包括I/O单元结构、异步逻辑和时序约束等众多方面，都会对编译进程产生巨大影响，致使其每一轮都会在工具链中产生不同的结果。为了更好、更快地完成时序收敛，我们来进一步探讨如何消除这些差异。I/O 单元结构所有FPGA都具有可实现高度定制的I/O引脚。定制会影响到时序、驱动强度、终端以及许多其它方面。如果您未明确定义I/O单元结构，则您的工具链往往会采用您预期或者不希望采用的默认结构。如下VHDL代码的目的是采用sda: inout std_logic;声明创建一个称为sda 的双向I/O缓冲器。tri_state_proc : PROCESS (sys_clk)BEGINif rising_edge(sys_clk) thenif (enable_in = 1) thensda = data_in;elsedata_out = sda;sda = Z;end if;end if;END PROCESS tri_state_proc;当综合工具发现这组代码时，其中缺乏如何实施双向缓冲器的明确指示。因此，工具会做出最合理的猜测。实现上述任务的一种方法是，在FPGA的I/O环上采用双向缓冲器（事实上，这是一种理想的实施方式）。另一种选择是采用三态输出缓冲器和输入缓冲器，二者都在查询表(LUT) 逻辑中实施。最后一种可行方法是，在I/O环上采用三态输出缓冲器，同时在LUT中采用输入缓冲器，这是大多数综合器选用的方法。这三种方法都可以生成有效逻辑，但是后两种实施方式会在I/O引脚与LUT之间传输信号时产生更长的路由延迟。此外，它们还需要附加的时序约束，以确保时序收敛。FPGA编辑器清晰表明：在图1中，我们的双向I/O有一部分散布在I/O缓冲器之外。教训是切记不要让综合工具猜测如何实施代码的关键部分。即使综合后的逻辑碰巧达到您的预期，在综合工具进入新版本
施工现场质量管理检查记录表25751
施工现场质量管理检查记录表
计量管理制度和计量设施精确度控制措施 1、集团设立计量科，负责本集团计量工作的综合管理。 2、计量科负责计量测试技术、量值传递和监督管理，保证本集团检测计量设备和计量数据的准确统一。 3、相关处室和车间具体负责本单位检测计量设备的使用、维护保养及送检工作。 4、检测计量设备台帐（或监视和测量装置台帐）、周期检定计划、原始记录及技术档案。 5、计量标准器及检测计量设备应健全技术档案，计量技术档案包括检测计量设备使用说明书、监视和测量装置维护保养与操作规程、检定/校准证书等。 6、计量科应健全监视和测量装置台帐；检测计量设备使用部门应健全监视和测量装置分台帐。 7、经检定合格的检测计量设备，外检的应出具检定/校准证书；自检的应出具合格证书，并有主管、检定员、核验员鉴字，加盖计量器具检定合格印章，加帖合格标识。 8、检测计量设备检定/校准证书存档四年；合格证书保存一个坚定周期；检定/校准原始记录存档一年。 9、严格执行《监视和测量装置维护保养与操作规程》 4.2 计量检定室环境 4.2.1 计量检定室保持清洁，室温恒定，易燃物器必须妥善保管。 4.2.2 严格执行《监视和测量装置维护保养与操作规程》。 4.3 业务培训 4.3.1 计量检定人员应持有上级计量部门颁发的有效资格证书。
4.3.2 计量科负责各生产车间及相关部门的计量管理员的业务培训和指导。 5 检测计量设备管理 5.1购置、验收 5.1.1 根据产品质量和过程控制的要求由使用部门提出购置申请。设备动力处或质检处分别负责填制《设备购置申请表》或《监视和测量装置购置申请表》，经部门负责人审核，总经理批准后，方可生效。并交由设备动力处或质检处办理采购事宜。 检测计量设备的购置应符合以下要求： a. 新购置的检测计量设备应符合计量法的规定，并有“ＣＭＣ”标志。 b.检测计量设备的有关技术要求应在相应检验规程中予以明确规定； c.精确度应与被测参数的允许误差相匹配； d.符合计量法关于计量单位使用要求的规定。 5.1.2 检测计量设备进厂后，设备动力处会同质检处依据检测计量设备说明书进行验收或委托法定检定部门验收。若验收合格，则予以进厂并办理入库手续；若验收不合格，由采购部门办理退货或维修事宜，直至验收合格。 4.1.3 检测计量设备附配件进厂，其验收、进厂入库、退货或维修程序同上4.1.2。 5.2 领用 5.2.1 有关生产车间及部门在领用计量器具时，应填写领料单，由计量科负责人签字(或盖章)后，方可到仓库领取。 5.2.2 仓库凭计量科负责人签字(或盖章)的领料单，发放计量器具，领用
- c语言程序代码编写规范
- 3 编写高质量代码
- 敏捷开发中高质量Java代码开发实践
- 高质量代码的设计特点
- 如何提高代码质量
- C#代码--编写高质量C#程序
- 软件工程8 编写高质量代码
- 第25讲高质量编码标准
- 我编写过的最漂亮的代码
- 良好的代码编写风格(二十五条)
- C#代码--编写高质量C#程序
- 敏捷开发中高质量Java代码开发实践
- 【思维导图】[编程书籍]-编写高质量代码：Web前端开发修炼之道
- 高手教你如何编写高效率稳定的单片机代码
- 编写高质量代码：改善C程序代码的125个建议
- 编写具有100%可靠性代码的几个技巧
- 如何开发高质量代码共43页文档
- 如何编写高质量的Javascript代码
- 编写高质量Java代码
- 高质量编程