PageRenderTime 70ms CodeModel.GetById 32ms RepoModel.GetById 0ms app.codeStats 0ms

/docs/html/styleguide/common-conventions.html

https://github.com/YuhangGe/kissyteam.github.com
HTML | 216 lines | 177 code | 20 blank | 19 comment | 0 complexity | 308d5e213bbbfd5f45aef8931b35a8a0 MD5 | raw file
    

  1. 

  2. <!doctype html>
    3. 

  3. 

  4. <html>
    5. 

  5. <head>
    6. 

  6. <meta charset="utf-8"/>
    7. 

  7. 

  8. <title>通用约定 &mdash; KISSY Docs valpha documentation</title>
    9. 

  9. 

  10. <link rel="stylesheet" href="../static/reset.css"/>
    11. 

  11. <link rel="stylesheet" href="../static/kissy.css"/>
    12. 

  12. <link rel="stylesheet" href="../static/pygments.css"/>
    13. 

  13. <link rel="shortcut icon" href="../static/favicon.ico"/>
    14. 

  14. <link href='http://fonts.googleapis.com/css?family=Philosopher' rel='stylesheet' type='text/css'>
    15. 

  15. 

  16. <script>
    17. 

  17.     var DOCUMENTATION_OPTIONS = {
    18. 

  18.         URL_ROOT:    '../',
    19. 

  19.         VERSION:     'alpha',
    20. 

  20.         COLLAPSE_INDEX: false,
    21. 

  21.         FILE_SUFFIX: '.html',
    22. 

  22.         HAS_SOURCE: true
    23. 

  23.     };
    24. 

  24. 

  25.     if(window.location.href.indexOf("localhost/kissy_git/")!=-1){
    26. 

  26.         document.write('<script src="http://localhost/kissy_git/kissy/build/kissy.js"'+'><'+'/script>');
    27. 

  27.     } else{
    28. 

  28.         document.write('<script src="http://yiminghe.github.com/kissy/build/kissy.js"'+'>'+'<'+'/script>');
    29. 

  29.     }
    30. 

  30. </script>
    31. 

  31.     <script type="text/javascript" src="../static/jquery.js"></script>
    32. 

  32.     <script type="text/javascript" src="../static/underscore.js"></script>
    33. 

  33.     <script type="text/javascript" src="../static/doctools.js"></script> 
    34. 

  34. </head>
    35. 

  35. <body><div id="header">
    36. 

  36.     <h1 class="logo"><a alt="KISSY" href="http://docs.kissyui.com"><img src="../static/logo.png"/></a></h1>
    37. 

  37.     <p class="desc">小巧灵活、简洁实用、愉悦编码、快乐开发</p>
    38. 

  38. 

  39.     <ul class="navigation">
    40. 

  40.         <li><a href="../../html/quickstart/index.html">快速上手</a></li>
    41. 

  41.         <li><a href="../../html/api/index.html">API</a></li>
    42. 

  42.         <li><a href="../../html/demo/index.html">DEMO</a></li>
    43. 

  43.         <li><a href="http://blog.kissyui.com/">博客</a></li>
    44. 

  44.         <!--<li><a href="mailto:all@kissyui.com">论坛</a></li>-->
    45. 

  45.         <li><a href="http://www.github.com/kissyteam">源码</a></li>
    46. 

  46.     </ul>
    47. 

  47. <div id="searchbox" style="display: none" class="searchbox">
    48. 

  48.     <form class="search" action="../search.html" method="get">
    49. 

  49.       <input type="text" name="q" size="28" class="ipt"/>
    50. 

  50.       <input type="submit" value="Go" class="btn"/>
    51. 

  51.       <input type="hidden" name="check_keywords" value="yes" />
    52. 

  52.       <input type="hidden" name="area" value="default" />
    53. 

  53.     </form>
    54. 

  54. </div>
    55. 

  55. <script type="text/javascript">$('#searchbox').show(0);</script>
    56. 

  56. 

  57. </div>
    58. 

  58. 

  59. <div id="content">
    60. 

  60.     
    61. 

  61. 	<div  class="layout grid-s6m0">
    62. 

  62. 			<div class="col-main">
    63. 

  63. 				<div class="main-wrap">
    64. 

  64. 

  65. <div class='related'>
    66. 

  66.     <h3>Navigation</h3>
    67. 

  67.     
    68. 

  68.     <ul>
    69. 

  69.     <li class="right" style="margin-right: 10px">
    70. 

  70.       <a href="../genindex.html" title="General Index"
    71. 

  71.          accesskey="I">index</a></li>
    72. 

  72.     <li class="right" >
    73. 

  73.       <a href="../py-modindex.html" title="Python Module Index"
    74. 

  74.          >modules</a> | </li>
    75. 

  75.     <li class="right" >
    76. 

  76.       <a href="css-coding-style.html" title="CSS 编码规范"
    77. 

  77.          accesskey="N">next</a> | </li>
    78. 

  78.     <li class="right" >
    79. 

  79.       <a href="index.html" title="最佳编码实践"
    80. 

  80.          accesskey="P">previous</a> | </li>
    81. 

  81.     <li><a href="../index.html">KISSY Docs</a> &#187; </li>
    82. 

  82.       <li><a href="index.html" accesskey="U">最佳编码实践</a> &#187; </li> 
    83. 

  83.     </ul>
    84. 

  84. </div>
    85. 

  85. 					
    86. 

  86.   <div class="section" id="styleguide-commonconventions">
    87. 

  87. <span id="id1"></span><h1>通用约定<a class="headerlink" href="#styleguide-commonconventions" title="Permalink to this headline"></a></h1>
    88. 

  88. <div class="section" id="id2">
    89. 

  89. <h2>文件与目录命名约定<a class="headerlink" href="#id2" title="Permalink to this headline"></a></h2>
    90. 

  90. <ol class="arabic simple">
    91. 

  91. <li>一律小写, 必须是英文单词或产品名称的拼音, 多个单词用连字符(-)连接. 只能出现英文字母、数字和连字符, 严禁出现中文.</li>
    92. 

  92. <li>出现版本号时, 需要用字母 v 做为前缀, 小版本号用点号(.)隔开, 比如 global-v8.js 或 detail-v2.2.js .</li>
    93. 

  93. <li>该命名规范适用于 html, css, js, swf, php, xml, png, gif, jpg, ico 等前端维护的所有文件类型和相关目录.</li>
    94. 

  94. <li>js 和 css 压缩文件, 统一以 -min 结尾, 比如源码文件为 kissy.js, 压缩后为 kissy-min.js .</li>
    95. 

  95. </ol>
    96. 

  96. </div>
    97. 

  97. <div class="section" id="id3">
    98. 

  98. <h2>文件编码约定<a class="headerlink" href="#id3" title="Permalink to this headline"></a></h2>
    99. 

  99. <blockquote>
    100. 

  100. <div><p>由于历史原因, 前端开发涉及的所有文本文件请统一 <strong>采用 GB2312, GBK 或 GB18030 编码</strong> .</p>
    101. 

  101. <p>注意：后台采用 UTF-8 的新项目, 或自主开发的项目, 推荐使用 UTF-8 编码.</p>
    102. 

  102. </div></blockquote>
    103. 

  103. </div>
    104. 

  104. <div class="section" id="id-class">
    105. 

  105. <h2>id 和 class 命名约定<a class="headerlink" href="#id-class" title="Permalink to this headline"></a></h2>
    106. 

  106. <ol class="arabic simple">
    107. 

  107. <li>id 和 class 的命名总规则为： <strong>内容优先,表现为辅</strong>. 首先根据内容来命名, 比如 main-nav. 如果根据内容找不到合适的命名, 可以再结合表现来定, 比如 skin-blue, present-tab, col-main.</li>
    108. 

  108. <li>id 和 class 名称一律小写, 多个单词用连字符连接, 比如 recommend-presents.</li>
    109. 

  109. <li>id 和 class 名称中只能出现小写的 26 个英文字母、数字和连字符(-), 任何其它字符都严禁出现.</li>
    110. 

  110. <li>id 和 class <strong>尽量用英文单词命名</strong> . 确实找不到合适的单词时, 可以考虑使用产品的中文拼音, 比如 wangwang, dating. 对于中国以及淘宝特色词汇, 也可以使用拼音, 比如 xiaobao, daigou. 除了产品名称和特色词汇, 其它任何情况下都严禁使用拼音.</li>
    111. 

  111. <li>在不影响语义的情况下, id 和 class 名称中可以适当采用英文单词缩写, 比如 col, nav, hd, bd, ft 等, 但切忌自造缩写.</li>
    112. 

  112. <li>id 和 class 名称中的第一个词必须是单词全拼或语义非常清晰的单词缩写, 比如 present, col.</li>
    113. 

  113. <li>仅在 JavaScript 代码中当作 hook 用的 id 或 class, 命名规则为 <tt class="docutils literal"><span class="pre">J_UpperCamelCase``(请注意,</span> <span class="pre">``J_</span></tt> 后的首字母也大写！), 其中字母 J 代表 JavaScript, 也是钩子(hook)的象形. 注意：如果在 JavaScript 和 CSS 中都需要用到, 则不用遵守本约定.</li>
    114. 

  114. <li>在自动化测试脚本中当作 hook 用的 class, 命名规则为 T_UpperCamelCase, 其中字母 T 代表 Test.</li>
    115. 

  115. </ol>
    116. 

  116. </div>
    117. 

  117. </div>
    118. 

  118. 

  119. 

  120. 					<div>
    121. 

  121.     <label>
    122. 

  122.         评论：
    123. 

  123.         <select id='openComment'>
    124. 

  124.             <option value='1'>打开</option>
    125. 

  125.             <option value='0'>关闭</option>
    126. 

  126.         </select>
    127. 

  127.     </label>
    128. 

  128.     <script>
    129. 

  129.         if(!window.localStorage){
    130. 

  130.             KISSY.one("#openComment").attr("disabled",true);
    131. 

  131.         }else{
    132. 

  132.             KISSY.one("#openComment").val(window.localStorage.getItem("kissy-commment")||"1");
    133. 

  133.             KISSY.one("#openComment").on("change",function(){
    134. 

  134.                 window.localStorage.setItem("kissy-commment",KISSY.one("#openComment").val());
    135. 

  135.                 window.location.reload();
    136. 

  136.             });
    137. 

  137.         }
    138. 

  138.     </script>
    139. 

  139. </div>
    140. 

  140. <div id="disqus_thread"></div>
    141. 

  141. <script>
    142. 

  142.     if((window.location.hostname.indexOf("kissyui.com")!=-1 )&& window.localStorage.getItem("kissy-commment")!="0"){
    143. 

  143.     /* * * CONFIGURATION VARIABLES: EDIT BEFORE PASTING INTO YOUR WEBPAGE * * */
    144. 

  144.     var disqus_shortname = 'kissy-docs'; // required: replace example with your forum shortname
    145. 

  145. 

  146.     // The following are highly recommended additional parameters. Remove the slashes in front to use.
    147. 

  147.      //var disqus_identifier = '/anim';
    148. 

  148.      //var disqus_url = window.location;
    149. 

  149. 

  150.     /* * * DON'T EDIT BELOW THIS LINE * * */
    151. 

  151.     (function() {
    152. 

  152.         var dsq = document.createElement('script'); dsq.type = 'text/javascript'; dsq.async = true;
    153. 

  153.         dsq.src = 'http://' + disqus_shortname + '.disqus.com/embed.js';
    154. 

  154.         (document.getElementsByTagName('head')[0] || document.getElementsByTagName('body')[0]).appendChild(dsq);
    155. 

  155.     })();
    156. 

  156.     }
    157. 

  157. </script>
    158. 

  158. <noscript>Please enable JavaScript to view the <a href="http://disqus.com/?ref_noscript">comments powered by Disqus.</a></noscript>
    159. 

  159. <a href="http://disqus.com" class="dsq-brlink">blog comments powered by <span class="logo-disqus">Disqus</span></a>
    160. 

  160. 

  161. <!--<div id="google-search-box">
    162. 

  162.     <div id="cse" style="width: 100%;">Loading</div>
    163. 

  163.     <script>
    164. 

  164.         if(window.location.hostname.indexOf("kissyui.com")!=-1){
    165. 

  165.             document.write('<script src="http://www.google.com/jsapi" type="text/javascript"><'+'/script>');
    166. 

  166.         }
    167. 

  167.     </script>
    168. 

  168.     <script>
    169. 

  169.         if(window.location.hostname.indexOf("kissyui.com")!=-1){
    170. 

  170.             google.load('search', '1', {language : 'zh-CN', style : google.loader.themes.MINIMALIST});
    171. 

  171.             google.setOnLoadCallback(function() {
    172. 

  172.                 var customSearchControl = new google.search.CustomSearchControl('012347804910294994683:n4uzb24gqdm');
    173. 

  173.                 customSearchControl.setResultSetSize(google.search.Search.FILTERED_CSE_RESULTSET);
    174. 

  174.                 customSearchControl.draw('cse');
    175. 

  175.             }, true);
    176. 

  176.         }
    177. 

  177.     </script>
    178. 

  178. </div>-->
    179. 

  179. 				</div>
    180. 

  180. 			</div>
    181. 

  181.     <div class="col-sub">
    182. 

  182. 

  183. <div class="s-box">
    184. 

  184.     <div class="s-box-bd">
    185. 

  185.         <ul class="current">
    186. 

  186. <li class="toctree-l1"><a class="reference internal" href="../quickstart/index.html">快速上手</a></li>
    187. 

  187. <li class="toctree-l1"><a class="reference internal" href="../api/index.html">API文档</a></li>
    188. 

  188. <li class="toctree-l1"><a class="reference internal" href="../demo/index.html">All Demos</a></li>
    189. 

  189. <li class="toctree-l1"><a class="reference internal" href="../relatedproj/index.html">子项目集</a></li>
    190. 

  190. <li class="toctree-l1 current"><a class="reference internal" href="index.html">最佳编码实践</a><ul class="current">
    191. 

  191. <li class="toctree-l2 current"><a class="current reference internal" href="">通用约定</a><ul>
    192. 

  192. <li class="toctree-l3"><a class="reference internal" href="#id2">文件与目录命名约定</a></li>
    193. 

  193. <li class="toctree-l3"><a class="reference internal" href="#id3">文件编码约定</a></li>
    194. 

  194. <li class="toctree-l3"><a class="reference internal" href="#id-class">id 和 class 命名约定</a></li>
    195. 

  195. </ul>
    196. 

  196. </li>
    197. 

  197. <li class="toctree-l2"><a class="reference internal" href="css-coding-style.html">CSS 编码规范</a></li>
    198. 

  198. <li class="toctree-l2"><a class="reference internal" href="html-coding-style.html">HTML 编码规范</a></li>
    199. 

  199. <li class="toctree-l2"><a class="reference internal" href="js-lang-rules.html">JavaScript 语言规范</a></li>
    200. 

  200. <li class="toctree-l2"><a class="reference internal" href="js-style-rules.html">JavaScript 编码风格</a></li>
    201. 

  201. </ul>
    202. 

  202. </li>
    203. 

  203. <li class="toctree-l1"><a class="reference internal" href="../tools/index.html">前端常用工具</a></li>
    204. 

  204. <li class="toctree-l1"><a class="reference internal" href="../workflow/index.html">组件开发指南</a></li>
    205. 

  205. </ul>
    206. 

  206. 

  207.     </div>
    208. 

  208. </div>
    209. 

  209.     </div>
    210. 

  210. 	</div>
    211. 

  211. </div>
    212. 

  212. <div id="footer">
    213. 

  213.     &copy; Copyright 2010~2011, KISSY Team. Created using <a href="http://sphinx.pocoo.org/">Sphinx</a>
    214. 

  214. </div>
    215. 

  215. </body>
    216. 

  216. </html>
    217.