html、CSS、および JavaScript フロントエンドの命名規則の詳細な説明

どこから来たのか思い出せませんが、偶然そのようなファイルを見つけたので、共有するために投稿しました。

技術的な観点からでも、開発の観点から見ても、Web フロントエンド開発仕様書には一定の基準があります。この記事では、CSS3 と HTML5 の開発見通しに関する一連の Web 開発ドキュメントをまとめています。のみ。

仕様の目的:

チームコラボレーションの効率を向上させ、バックエンド担当者による機能の追加とフロントエンドの最適化後のメンテナンスを容易にし、高品質のドキュメントを出力するために、これはこの仕様書が確認されたら、フロントエンド開発者はこの仕様書に従ってフロントエンドページを開発する必要があります。このドキュメントに誤りや不適切な点がある場合は、期限内に提出してください。議論と決定の後、変更することができます

基本的なガイドライン:

Web 標準に準拠し、構造、パフォーマンス、動作が分離されており、ページの互換性が優れています。パフォーマンスを向上させるために、サーバーの負荷をできるだけ軽減し、最速の解析速度を確保するために、コードは簡潔、明瞭、整然としている必要があります。

1画像ファイルはすべて、<システム開発仕様>で合意されたディレクトリにアーカイブされます。2. HTML ファイルの名前: 英語の名前、拡張子 .htm を同じディレクトリに配置します。 、インターフェースのドラフトが中国語で名前付けされている場合は、バックエンドが機能を追加するときに対応するページを見つけやすくするために、HTML ファイルと同じ名前に変更してください

3. CSS ファイルの名前: 英語名、接尾辞 .css。共有base.css、ホームページindex.css、その他のページは実際のモジュール要件に従って名前が付けられます。

HTML仕様で記述

1. ドキュメントタイプの宣言とエンコーディング: ; に統一されたエンコーディング/>、インデントを記述するときに明確な階層を実現するには IDE を使用します。 2. 特殊な状況を除き、スタイル ファイルは ...; の間にリンクする必要があります。ファイルはページの下部にリンクする必要があります。

3. スタイル ファイルまたは JavaScript ファイルをインポートする場合は、デフォルトの型宣言を省略して次のように記述する必要があります:

4. JS ライブラリ ファイルをインポートする場合、ファイル名にはライブラリ名とバージョン番号、およびプラグインを導入する圧縮バージョン (jquery-1.4.1.min.js など) が含まれている必要があります。ファイル名の形式はライブラリ名 + プラグインです。 -in 名 (例: jQuery.cookie.js;

) 5. すべてのコーディングは xhtml 標準に従い、タグと属性& 属性名は小文字と下線付きの数字で構成され、br (< を含む) のタグはすべて閉じられている必要があります。 ;br />)、hr (

---

6. 互換性の問題がない HTML タグを最大限に活用します。 HTML 要素にカスタム属性を追加する必要がある場合は、デフォルトの既存のタグがあるかどうかを最初に検討する必要があります。ない場合は、「data-」を使用できます。カスタム属性を追加し、「data:」やその他の命名方法の使用を避けるためのプレフィックスとして " を使用します。

7. 重要性に基づくタイトルなどのセマンティック HTML h* を使用します (同じページには h1 が 1 つだけ存在できます) 、段落タグには p を使用し、リストには ul を使用します。ブロックレベル要素はインライン要素内でネストできません。

など、p のネストをできるだけ減らします。

XXX へようこそ。あなたのユーザー名は

username

<次のコードに完全に置き換えることができます。 :

XXX へようこそ、あなたのユーザー名は username

< ;/p>; を書くとき。リンク アドレスの場合は、リダイレクトを避ける必要があります。たとえば、href="http://itaolun.com/"、つまり、URL アドレスの後に「/」を追加する必要があります。

10. 在页面中尽量避免使用style属性,即style=”…”;

11. 必须为含有描述性表单元素(input, textarea)添加label, 如

<p>姓名: <input type=”text” id=”name” name=”name” /></p>须写成:<p><label for=”name”>姓名: </label><input type=”text” id=”name” /></p>

12. 能以背景形式呈现的图片, 尽量写入css样式中;

13. 重要图片必须加上alt属性; 给重要的元素和截断的元素加上title;

14. 给区块代码及重要功能(比如循环)加上注释, 方便后台添加功能;

15. 特殊符号使用: 尽可能使用代码替代: 比如 <(<) & >(>) & 空格( ) & ?(?) 等等;

16. 书写页面过程中, 请考虑向后扩展性;

17. class & id 参见 css书写规范.

css书写规范

1. 编码统一为utf-8;

2. 协作开发及分工: i会根据各个模块, 同时根据页面相似程序, 事先写好大体框架文件, 分配给前端人员实现内部结构&表现&行为; 共用css文件base.css由i书写, 协作开发过程中, 每个页面请务必都要引入, 此文件包含reset及头部底部样式, 此文件不可随意修改;

3. class与id的使用: id是唯一的并是父级的, class是可以重复的并是子级的, 所以id仅使用在大的模块上, class可用在重复使用率高及子级中; id原则上都是由我分发框架文件时命名的, 为JavaScript预留钩子的除外;

4. 为JavaScript预留钩子的命名, 请以 js_ 起始, 比如: js_hide, js_show;

5. class与id命名: 大的框架命名比如header/footer/wrapper/left/right之类的在2中由i统一命名.其他样式名称由 小写英文 & 数字 & _ 来组合命名, 如i_comment, fontred, width200; 避免使用中文拼音, 尽量使用简易的单词组合; 总之, 命名要语义化, 简明化.

6. 规避class与id命名(此条重要, 若有不明白请及时与i沟通):

a, 通过从属写法规避, 示例见d;

b, 取父级元素id/class命名部分命名, 示例见d;

c, 重复使用率高的命名, 请以自己代号加下划线起始, 比如i_clear;

d, a,b两条, 适用于在2中已建好框架的页面, 如, 要在2中已建好框架的页面代码

中加入新的p元素,

按a命名法则:

…

,

样式写法: #mainnav .firstnav{…….}

按b命名法则:

…

,

样式写法: .main_firstnav{…….}

7. css属性书写顺序, 建议遵循 布局定位属性–>自身属性–>文本属性–>其他属性. 此条可根据自身习惯书写, 但尽量保证同类属性写在一起. 属性列举: 布局定位属性主要包括: margin ＆ padding ＆ float（包括clear） ＆ position（相应的 top,right,bottom,left） ＆ display ＆ visibility ＆ overflow等； 自身属性主要包括: width & height & background & border; 文本属性主要包括： font ＆ color ＆ text-align ＆ text-decoration ＆ text-indent等；其他属性包括: list-style(列表样式) ＆ vertical-vlign ＆ cursor ＆ z-index(层叠顺序) ＆ zoom等. 我所列出的这些属性只是最常用到的, 并不代表全部;

8. 书写代码前, 考虑并提高样式重复使用率;

9. 充分利用html自身属性及样式继承原理减少代码量, 比如:

• 这儿是标题列表2010-09-15

定义

ul.list li{position:relative} ul.list li span{position:absolute; right:0}

即可实现日期居右显示

10. 样式表中中文字体名, 请务必转码成unicode码, 以避免编码错误时乱码;

11. 背景图片请尽可能使用sprite技术, 减小http请求, 考虑到多人协作开发, sprite按模块制作;

12. 使用table标签时(尽量避免使用table标签), 请不要用width/ height/cellspacing/cellpadding等table属性直接定义表现, 应尽可能的利用table自身私有属性分离结构与表现, 如

thead,tr,th,td,tbody,tfoot,colgroup,scope; (cellspaing及cellpadding的css控制方法: 
table{border:0;margin:0;border-collapse:collapse;} table th, table td{padding:0;} ,

base.css文件中我会初始化表格样式)

13. 杜绝使用 兼容ie8;

14. 用png图片做图片时, 要求图片格式为png-8格式,若png-8实在影响图片质量或其中有半透明效果, 请为ie6单独定义背景:

_background:none;_filter:progid:DXImageTransform.Microsoft.AlphaImageLoader(sizingMethod=crop, src=’img/bg.png’);

15. 避免兼容性属性的使用, 比如text-shadow || css3的相关属性;

16. 减少使用影响性能的属性, 比如position:absolute || float ;

17. 必须为大区块样式添加注释, 小区块适量注释;

18. 代码缩进与格式: 建议单行书写, 可根据自身习惯, 后期优化i会统一处理;

JavaScript书写规范

1. 文件编码统一为utf-8, 书写过程过, 每行代码结束必须有分号; 原则上所有功能均根据XXX项目需求原生开发, 以避免网上down下来的代码造成的代码污染(沉冗代码 || 与现有代码冲突 || …);

2. 库引入: 原则上仅引入jQuery库, 若需引入第三方库, 须与团队其他人员讨论决定;

3. 变量命名: 驼峰式命名. 原生JavaScript变量要求是纯英文字母, 首字母须小写, 如iTaoLun;

jQuery变量要求首字符为’_’, 其他与原生JavaScript 规则相同, 如: _iTaoLun;

另, 要求变量集中声明, 避免全局变量.

4. 类命名: 首字母大写, 驼峰式命名. 如 ITaoLun;

5. 函数命名: 首字母小写驼峰式命名. 如iTaoLun();

6. 命名语义化, 尽可能利用英文单词或其缩写;

7. 尽量避免使用存在兼容性及消耗资源的方法或属性, 比如eval() & innerText;

8. 后期优化中, JavaScript非注释类中文字符须转换成unicode编码使用, 以避免编码错误时乱码显示;

9. 代码结构明了, 加适量注释. 提高函数重用率;

10. 注重与html分离, 减小reflow, 注重性能.

 

图片规范

1. 所有页面元素类图片均放入img文件夹, 测试用图片放于img/demoimg文件夹;

2. 图片格式仅限于gif || png || jpg;

3. すべての名前には、小文字の英字 || _ を組み合わせて使用​​する必要があります。漢字の特殊文字は使用できません || 他のチームが理解しやすいようにするため、さらに、先頭と末尾に名前を付けます (ad_left01.gif || btn_submit.gif)。 4. 視覚効果を確保しながら、最小の画像形式と画質を選択します。

5. 半透明の PNG 画像の使用は避けてください (使用する場合は、CSS 仕様の関連手順を参照してください)。ページの http リクエストを減らしますが、必ず対応するスプライト PSD ソース画像に参照線を描画し、

注釈仕様

1. format

2. css 形式 /*ここにコメントがあります*/;

3. JavaScript コメント、単一行のコメント「//これは単一行のコメントです」を使用し、複数行のコメントは /* これは複数行のコメントです*/ ; | Vim、自分の好みに応じて選択することもできますが、次の原則に従う必要があります:

2. コードを「描画」するために IDE のビュー モードを使用することはできません。 IDE を使用して、JS の組み込み関数などの関連関数コードを生成することはできません。

テスト ツール: FireFox と IE6 と IE7 のみをテストします。

推奨されるテスト順序: FireFox – > IE7 – > IE8 – > IE6 – > Opera – > Chrome – > Safari。Firebug および IE Tab Plus プラグインをインストールすることをお勧めします。

その他の仕様

1. CSS の再利用率を高め、作業を分担するようにページを完成させます。繰り返しの開発 2. 冗長なコードを減らし、誰でも理解できるようにすることは美徳です。

以上がhtml、CSS、および JavaScript フロントエンドの命名規則の詳細な説明の詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。