`
withyou
  • 浏览: 454948 次
社区版块
存档分类
最新评论

代码质量与文档质量

阅读更多
  几段在脑子里盘旋了很久的话:
 
  带一个项目,要保证项目的质量,当然要靠Team Leader的水平。那么,什么才是最重要的项目质量呢?当然是代码质量!一个软件项目,最重要的产品当然是代码!
 
  如果这个Leader看不懂项目的代码,他只能通过要求文档的质量,来间接的控制代码的质量。一个能够看得懂代码的Leader,他就能够直接控制代码质量。而能够直接控制代码质量的Leader,对于文档的要求,会合理很多。
 
  直接控制与间接控制,哪一个更加有效,是不言而喻的。当然,那些没有代码阅读能力的Leader,他们会更加强调文档的重要性,甚至舍本逐末,认为文档质量才是项目质量的体现。进而变态地追求文档完美,以至于浪费了程序员写代码的时间。这样的Leader,根本就不可能管好项目的。
 
  公司往往会出于恐慌,向员工要求很多详尽的文档,主要是为了防止员工离职带来的损失。而问题在于,公司的主要努力,应该用于留住员工,而不是用于加强“善后能力”。更不是为了增强善后能力,搞得员工越发想离开这家公司。
 
btw:
 
补记一段交锋对话:
软件开发项目中的成本比例》是我以前写的一篇blog,有一个GHawk有这么一段留言:
 
UP和Agile都是工程过程实践的总结,林德彰先生说过“UP是正楷,XP是草书。先学好了UP,才能学好XP;先学XP再学UP就会乱套。”
Agile强调的是“代码是真正有价值的东西。”这同样也是实践的结果。二位对于过程有不同的看法并不能说明孰是孰非,这只是在不同的实践内容和阶段上的总结。在过程的选用问题上,只有不断地实践才是前进的方向。 
 
另外还有一篇blog,专门讨论这句话。
 
我的回答是:
 
林德彰的说法,是一个在校教师,典型的和稀泥的说法,我不同意。
 
没想到今天有一个朋友WANG回了一帖:
 
老林是在校教师?你应该去看一下人家在美国打拼的经验~~  
 
我的回复是:
他在美国打拼怎么了?还有好多土生土长的美国人,也不鸟那什么UP呢?
我为什么要听一个海龟来上课呢?
这年头,海龟还不够多吗?

另外对GHawk多说一句话:让组员快速磨合的最好办法,是结对编程,而不是大家埋头写文档。


分享到:
评论

相关推荐

    软件开发与代码质量-ppt

    本资料"软件开发与代码质量-ppt"提供了一个全面的视角,探讨了如何在实践中确保代码质量的同时,有效地进行项目管理、代码管理、团队管理和知识管理。以下是对这些关键知识点的详细解释。 1. 项目管理:项目管理...

    代码质量管理资料 包

    本资料包包含了一系列与代码质量管理相关的文章和文档,涵盖了多个重要方面,如代码评审、单元测试、程序复杂度度量、IBM的代码质量标准、代码质量概述、C语言编程规范以及静态代码分析理论。以下是对这些知识点的...

    java代码审查规范文档

    Code Review主要用来在软件工程过程中改进代码质量,通过Code Review可以达到如下目的: .在项目早期就能够发现代码中的BUG。 .帮助初级开发人员学习高级开发人员的经验,达到知识共享。 .避免开发人员犯一些很常见...

    C++代码文档生成器 根据代码及注释自动生成代码文档.zip

    - **保持良好的注释习惯**:为了生成高质量的文档,代码应该有清晰、详尽的注释,描述类的功能、函数的作用、参数的意义以及返回值等。 - **配置设置**:根据项目需求,可能需要调整工具的配置,例如设定输出格式、...

    代码质量与评审.pptx

    代码质量与评审.pptx

    IBM java代码质量专题

    IBM作为全球领先的科技企业,其在Java代码质量方面的专题探讨,无疑为业界提供了宝贵的指导与实践案例。以下是从“IBM Java代码质量专题”中提炼出的重要知识点,旨在帮助开发者提升Java代码的质量,构建更稳定、...

    软件质量相关文档

    4. **软件生命周期中的质量管理**:从需求分析、设计、编码、测试到维护,每个阶段都应关注质量,实施相应的质量保证活动,如代码审查、单元测试和集成测试。 5. **敏捷开发与质量**:敏捷方法强调快速迭代和持续...

    提高代码质量(Java篇).pptx

    提高代码质量(Java篇) 本资源摘要信息关注提高代码质量,主要涵盖编码规范、静态代码分析、单元测试、代码评审和重构、持续集成等方面。 一、编码规范 编码规范是提高代码质量的基础。编码规范主要包含以下几个...

    SonarQube代码质量管理平台的介绍与安装_PPT

    它能够从七个维度来评估代码质量,包括代码复杂度、重复代码、单元测试覆盖率、编码规范、注释、潜在Bug以及结构与设计。代码复杂度过高时,代码将难以理解和维护;程序中大量复制粘贴的代码表明质量低下;单元测试...

    一堂如何提高代码质量的培训课(2)

    综上所述,提高代码质量涉及多个层面,包括源码管理、工具应用、测试策略和文档编制。每个环节都对整体质量有直接影响。通过持续学习和实践,开发者可以不断提升自己的技能,编写出更高质量的代码,从而为软件项目...

    源代码质量评审工具(适用于所有语言)

    源代码质量评审是软件开发过程中的重要环节,它旨在确保代码的质量、可读性、可维护性和性能。本文将深入探讨一款适用于所有编程语言的源代码质量评审工具,该工具可以显著减轻QA的工作负担。 标题提及的“源代码...

    代码大全PPT文档

    5. **测试驱动开发(TDD)**:TDD是一种先写测试后写代码的开发方法,有助于保证代码质量。PPT可能讲解了如何编写单元测试,以及TDD对项目管理的影响。 6. **重构**:重构是改善代码结构而不改变其外在行为的过程。...

    代码质量随想录

    "代码质量随想录"是一系列文档,旨在引导初学者和有经验的开发者优化他们的编码习惯,从而提升代码质量,成为更出色的程序员。以下是对这些文件主题的详细解读: 1. **代码质量随想录(一):可读是王道** 可读性...

    代码注释生成文档工具

    通过利用代码注释生成文档工具,开发团队可以更专注于代码开发,而不是花费大量时间在编写和维护文档上,同时还能保证文档的质量和一致性。在实际工作中,选择合适的工具并遵循良好的注释习惯,将大大提升项目的可...

    代码大全—完整TXT文档

    软件质量与编程思想 - **软件质量的重要性**:阐述了软件质量对于最终产品的影响,强调了高质量代码的重要性。 - **编程思想的发展**:介绍了编程思想随时间的变化和发展趋势,帮助读者理解当前流行的编程思想及其...

    软件质量保证过程 文档

    开发人员**:承担单元测试和Alpha测试的责任,确保代码质量,并在早期发现和修复缺陷。 **3. 测试负责人**:制定测试计划,监督测试流程,确保测试活动按计划执行,保障测试质量和效率。 **4. 测试人员**:执行...

    非常优秀的代码文档管理工具

    它特别适用于那些规模适中、需要团队合作的项目,能够帮助团队成员有效地共享和管理资源,确保代码质量并减少冲突。 标签“SVN”是指Subversion(简称SVN),这是一个广泛使用的版本控制系统。SVN的核心功能是跟踪...

    VS c# 生成 文档 注释 源代码

    【标题】:“VS c# 生成 文档 注释 源代码”涉及到的是在Visual Studio (VS) 使用C#编程语言时如何自动生成并处理XML文档注释的过程。...通过掌握这些技能,开发者可以提升代码质量和团队协作效率。

    软件著作权代码文档生成器v1.0.0源代码1

    它可以自动地生成软件著作权代码文档,提高软件开发效率和质量。本文档生成器使用Java语言开发,基于Maven项目管理工具。下面是本文档生成器的知识点总结: 一、Maven项目管理工具 Maven是一个基于项目对象模型...

    sonarqube代码质量检测工具

    Sonar是一个用于代码质量管理的开源平台,用于管理Java源代码的质量。通过插件机制,Sonar 可以集成不同的测试工具,代码分析工具,以及持续集成工具,比如pmd-cpd、checkstyle、findbugs、Jenkins。通过不同的插件...

Global site tag (gtag.js) - Google Analytics