`
Franciswmf
  • 浏览: 802618 次
  • 性别: Icon_minigender_1
  • 来自: 上海
文章分类
社区版块
存档分类
最新评论

代码规范-文档编写

 
阅读更多
一、代码规范
1、Alibaba Java Coding Guidelines Eclipse Plugin 阿里java代码规范插件
https://p3c.alibaba.com/plugin/eclipse/update
2、阿里代码规范检查工具的安装使用
https://www.cnblogs.com/chenjfblog/p/7685579.html
--P3C源码
https://github.com/alibaba/p3c


二、文档编写
--软件工程的需求分析、概要设计、详细设计的区别
https://yiran2014.iteye.com/blog/2104399
https://blog.csdn.net/xiangxizhishi/article/details/80507479
2.1 需求分析


2.2 概要设计
http://www.cnblogs.com/bmaker/p/6116177.html
http://www.cnblogs.com/bmaker/p/6116170.html

2.3 详细设计

2.4 数据库设计

2.5 安装手册

2.6 用户手册

分享到:
评论

相关推荐

    阿里巴巴代码规范-泰山版.pdf

    阿里巴巴代码规范,又被称为阿里巴巴Java开发手册泰山版,是一份由阿里巴巴技术团队编写的、旨在规范Java开发者编程行为和提高代码质量的文档。该手册不仅关注编码细节,还涉及软件开发的多个方面,如异常处理、日志...

    C# 编程规范---代码编写风格

    ### C# 编程规范详解:代码编写风格与实践 #### 概述 在软件开发领域,编程规范的建立对于确保代码质量、提高团队协作效率以及简化代码维护工作至关重要。东软集团有限公司发布的《C#编程规范2.0》正是为了达到这...

    前端代码规范 - v1.0.docx

    本文档旨在提供一个通用的前端代码规范,涵盖 HTML、CSS、JS 和 Vue 代码规范,适合公司开发人员参考和借鉴。 概述 前端代码规范的目的在于提高代码的质量和可维护性,确保代码的可读性和可扩展性,减少错误和 Bug...

    软件开发文档编写标准规范

    《软件开发文档编写标准规范》是一份至关重要的参考资料,它为软件开发团队提供了一套详细的指导原则和格式,确保在项目开发过程中产生的各种文档能够清晰、一致且有效地传达信息。文档是软件工程的重要组成部分,它...

    系统开发规范与文档编写教程

    在系统开发过程中,规范与文档编写是至关重要的环节。它们不仅确保了项目团队之间的有效沟通,还能提高开发效率,降低维护成本,确保系统的稳定性和可扩展性。本教程旨在帮助好学的朋友快速掌握系统开发文档的编写...

    更锋利的C#代码--编写高质量C#程序

    ### 更锋利的C#代码--编写高质量C#程序 ...总之,遵循这些规范不仅有助于提高个人编码水平,也有助于提高整个团队的工作效率和代码质量。无论是个人项目还是团队协作,这些规则都是非常有价值的。

    软件文档编写 --软件文档写作

    总之,软件文档编写是一项关键的软件工程活动,它贯穿于整个软件开发过程,对于软件的成功开发和维护至关重要。开发者应当重视文档的编写,确保文档的完整性和准确性,以促进团队协作,确保软件项目的顺利进行。

    代码编写规范

    ##### 3.1 Delphi代码规范 - **BEGIN-END配对**:Delphi代码中,BEGIN和END必须正确配对。 - **命名规范**: - 过程和函数命名:采用有意义的动词或动宾短语,首字母大写。 - 变量命名:使用描述性的名词或形容词+...

    Verilog-HDL编写规范(全)

    通过阅读“Verilog-HDL编写规范(全)”这份文档,你可以深入了解以上知识点,并掌握编写高效Verilog代码的技巧。这个规范不仅包含了语言的语法和用法,还可能包含最佳实践、设计原则和常见问题解决方案,对于提升你...

    单片机程序编写代码规范工具

    单片机程序编写是电子工程和嵌入式系统开发中的重要环节,良好的代码规范对于项目的可维护性、可读性和团队协作至关重要。本工具旨在帮助开发者遵循一定的编码标准,提高代码质量,降低后期维护难度。以下是一些关于...

    就业安卓研发规范-文档

    11. **文档编写**:规范可能包含关于编写清晰、全面的API文档和用户手册的要求,以便团队成员和用户理解代码功能。 12. **国际化与本地化**:针对多语言支持,说明资源文件的组织方式,以及如何处理字符串、日期和...

    C#代码规范文档doc

    · 代码的编写保持一致性, · 提高代码的可读性和可维护性, · 在团队开发一个项目的情况下,程序员之间可代码共享 · 易于代码的回顾, 本规范是初版,只适用于一般情况的通用规范,并不能覆盖所有的情况。

    软件部项目管理-管理规范文档-一套

    2.软件部项目管理-项目开发规范-代码编写要求 3.软件部项目管理-项目开发规范-技术文档书写 4.软件部项目管理-项目开发规范-界面设计要求 5.软件部项目管理-项目开发规范-开发过程管理 6.软件部项目管理-项目开发...

    国家软件开发文档编写规范

    《国家软件开发文档编写规范》是中国信息化建设领域的一项重要指导性文件,旨在为软件开发团队提供一套统一、标准的文档编制方法,确保软件项目的高效、规范进行。文档编写规范是软件开发过程中的基石,它涵盖了从...

    JAVA-WEB团队开发组交接文档编写规范

    JAVA-WEB团队开发组交接文档编写规范,特点:便于团队代码开发管理规范,简洁,清楚,明了。

    Delphi程序员代码编写规范

    Delphi程序员代码编写规范是一份指导程序员按照统一标准进行编程的文档,旨在提高代码的可读性、可维护性和团队协作效率。以下是对规范中各部分的详细解释: 一、序言 序言部分强调了这份规范的重要性,尽管它不是...

    Java软件开发文档代码规范

    在软件开发领域中,Java作为一种广泛使用的编程语言,其代码规范对于项目的可维护性和团队协作至关重要。本知识点将根据文档内容详细介绍Java软件开发中的代码组织与风格、注解规则、命名规范以及如何编写高质量的...

    百度前端代码规范.pdf

    最后,文档的构建工具书栈(***)是一个在线文档构建平台,它不仅提供了文档编写、整理、归类等功能,还支持内容的生成和导出。尽管书栈无法确认文档内容的准确性,但它提供了反馈机制,允许用户报告发现的问题,从而...

    java程序代码编写的详细规范

    详细介绍编写代码的注意点,让代码看起来有条理,更清晰! 编码规范对于程序员而言尤为重要,有以下几个原因:(1)一个软件的生命周期中,80%的花费在于维护。(2)几乎没有任何一个软件,在其整个生命周期中,均由...

    C#代码规范 常用的代码编写规则

    C#代码规范是确保代码可读性、可维护性和团队协作效率的重要标准。这份规范涵盖了多个方面,包括但不限于代码外观、程序注释、声明、命名规范、语句结构以及控件命名规则。以下是对这些规范的详细解释: **第一章 ...

Global site tag (gtag.js) - Google Analytics