HTML文档编写规范

(1)HTML标记是由尖括号包围的关键词。所有标记均以“<”开始,以“>”结束。结束的标记在开始名称前加上斜杠“/”。例如头部标记格式如下所示:<head> ……</head>

(2)根据标记类型,正确书写标记,单个标记最好在右尖括号前加1个斜杠“/”,如换行标记是单个标记“<br>”,成对标记最好同时输入开始标记和结束标记,以免忘记。

(3)标记可以相互嵌套(也称为包含),但不能交叉。如:

<head><title>……</title></head>   <!--这是正确的书写格式-->

<head><style>……</head></style>    <!--这是错误的书写格式-->

(4)在HTML代码书写时不区分大小写,如头部标记写成<HEAD>,<head>,<Head>,<HEAd>都可以,但建议在同一个Web开发项目保持一种风格,如统一小写标记名称。

(5)代码中包含任意多的回车符和空格在HTML页面显示时均不起作用。需要时可使用<br />和&nbsp;来实现换行和插入空格。为了代码清晰,建议不同的标记都独占一行。

(6)给标记设置属性时,属性值建议用双引号标注起来。如段落内容居中格式如下所示:<p align="center">这是段落信息居中显示</p>

(7)书写开始与结束标记时,在左尖括号与标记名或与斜杠“/”之间不能留有多余空格,否则浏览器不能识别该标记,导致错误标记直接显示在页面上,影响页面美观效果。例如:

<  comment>显示一个段落<  /comment>

(8)编写HTML代码时,应该使用锯齿结构,即向右缩进2~4个字符,使代码结构清晰,提高代码的可读性,为后期阅读和维护提供帮助。

原文地址:https://www.cnblogs.com/zuiranlanyan/p/10628414.html

时间: 2024-10-06 13:46:07

HTML文档编写规范的相关文章

蒟蒻的代码规范与文档编写规范

代码规范 代码每行不得超过 80 个字符: 代码不分块.连续编写,且每一个模块不允许超过 100 行: 双目运算符运算对象与运算符之间一定要分别打一个空格,单目运算符与运算对象之间不打空格: 禁止使用 Tab 缩进,使用 2 空格缩进代码. 宏定义时没有缩进. 基本使用 Java 代码风格,如果在 for.if 后只有一两个语句,尽量不使用大括号包围,如果一定要使用大括号,则尽量压行书写. 模块化的代码,提倡代码宽而短,不提倡瘦长的代码风格. 没有通用的头文件,随用随加. 尽量开局部变量,减少全

PHP 高级程序设计(1) - 编码规范及文档编写

PHP 高级程序设计学习笔记20140612 软件开发中的一个重要环节就是文档编写.他可以帮助未来的程序维护人员和使用者理解你在开发时的思路.也便于日后重新查看代码时不至于无从下手.文档还有一个重要的作用,在不用了解要访问对象的细节情况下也能很好的在对象之间进行交互.文档的编写有一些成熟的行业标准格式,遵守这些行业标准将有助于创建易于阅读的代表,并使自动生成手册成为可能. 编码规范 编码规范可能很多开发人员都有各自的观点也意见,且大家不尽相同.其实只要团队成员之间达成一致,遵循同一个标准就好.

从零开始编写自己的C#框架(4)——文档编写说明

原文:从零开始编写自己的C#框架(4)--文档编写说明 在写本系列的过程中,了解得越多越不知道从哪里做为切入点来写,几乎每个知识点展开来说都可以写成一本书.而自己在写作与文档编写方面来说,还是一个初鸟级别,所以只能从大方面说说,在本框架开发所需的范围内来讲述相关要用到的知识点,至于要更深入的去了解,请大家观看其他大牛的博客或购买书籍来学习. 为了加快进度,会对目录进行修改,将一些知识点合并或在后面使用的章节再进行描述. 谢谢大家的支持,如果您觉得本文对您有所帮助,请帮忙点击支持或发表评论. 在开

第一次文档编写总结(机房收费系统)

从图中可以看出编写文档的顺序,从可行性研究报告到开发进度月报构成了机房收费系统的整体文档,贯穿了软件工程的整个生命周期. 第一次机房收费系统和软工视频的完成是编写文档的依据和基础.起初,是一种无从下手的感觉.首先我们应该清楚文档是指导我们开发的,是在代码开发之前写的,而不是开发之后写的.有了学生信息管理系统的基础,我们第一次机房收费系统只是尝试着去写代码完成要求的功能,而不是一次正规的开发.人力物力财力都没有系统正规地去考虑.开发前的分析设计.开发中的细节和开发后的维护我们都没有涉及到.因此,编

关于文档注释规范

关于文档注释规范 准备工作: 双击打开文件夹 用editplus或其他编辑器打开 修改配置文件中: 引入配置文件: Step1:将模板配置文件放在myeclipse的安装目录下 Step2:window ---> preference Step3:导入配置文件 使用: Step1: Step2:则会自动生成注释,按上面的要求写注释 关于编码规范 参考<华为编码规范>文档. 附录: <?xml version="1.0" encoding="UTF-8&

Atitit usrQBK1600 技术文档的规范标准化解决方案

1.1. Keyword关键词..展关键词,横向拓展比较,纵向抽象细化拓展知识点1 1.2. 标题必须有高大上词汇,参考文章排行榜,1 1.3. 标题带语言关键词c#.net js javascript  c++ python1 1.4. 标题最好有英文版本的,方便英文查询1 1.5. 标题atitit前缀,attilax总结结尾方便查询1 1.6. 标题后面带上版本号v2 qbf等,方便时间对比1 1.7. 正文要求 修辞好(引用典故名句,成语 等,使用修辞方法)2 1.8. 引用寓言故事 类

如何根据需求分析文档编写测试用例

从拿到需求文档不要立马开始着手写测试用例,需要仔细推敲整理需求,画出系统级.模块内流程图,并找出各种测试点,等对需求进行了头脑风暴般的整理之后,此时已对测试系统的功能很清楚了, 再着手开始写测试用例. 那么编写测试用例的总体思路是什么呢? 1.整理分析需求文档 仔细将需求文档阅读一遍,记录不明白的地方及关键测试点,简单画出总体流程图. 然后再来一遍,仔细分析各个模块的功能,画出模块内流程图,找出所有功能,并列出主要测试点 2.编写用例 按照不同的业务规则可将测试用例分为四部分: 场景用例.系统用

第二章-第三题(四则元算需求文档编写、上传至GitHub与修改)-By郭青云

题目描述: 完成小组的“四则运算”项目的需求文档(使用Markdown写文档),尝试同组成员在各自PC上修改同一文档后,如何使用Git命令完成GitHub上的文档的更新,而不产生冲突.并验证GitHub上的文档确实是最新的文档. 步骤: a)编写文档 b)从代码库中pull项目至本地分支 c)修改需求文档 d)提交修改 d)合并修改的内容

java文档注释规范(一)

https://blog.csdn.net/huangsiqian/article/details/82725214 Javadoc工具将从四种不同类型的“源”文件生成输出文档:Java语言类的源文件(.java),包注释文件,概述注释文件和其他未处理的文件. 包注释文件(Package Comment File)每个包都有自己的文档注释.有两种方式来创建包注释文件: package-info.java - 可以包含包的声明,包注解(anotation),包注释和Javadoc 标签(tag).