【问题标题】:How to document a webpage HTML and CSS using comments [closed]如何使用评论记录网页 HTML 和 CSS [关闭]
【发布时间】:2014-09-11 10:01:57
【问题描述】:

是否有任何标准来开发 HTML 和 CSS 文件的文档,以便其他开发人员能够理解使用 cmets 和代码结构?

【问题讨论】:

标签: html css documentation comments


【解决方案1】:

您可以做几件事来让其他开发人员更容易理解您的代码。我认为最重要的是正确缩进你的代码。

代码结构对于理解所使用的不同元素至关重要。如果操作正确,HTML 和 CSS 很容易阅读和理解。

正确的方法:

<div class="done_right"> 
   <ul>
       <li>
           <p>
              "This is the right way!"
           </p>
       </li><!---End of li--->
   </ul><!---End of ul--->
</div> <!---End of done_right--->

这是一个有点夸张的例子,但是在元素结束的地方缩进和注释会很有帮助,尤其是在处理长行代码时。

对于 CSS 部分,我建议将不同的元素分成不同的部分。

比如说你必须要页面——叫做“index”和“contact”。

我会将每个页面的所有代码放在它自己的“部分”中。像这样:

/*******Index Page******/
.index_header{
   background-color: red;
 }

/*******Contact Page******/
.contact_header{
   background-color: green;
 }

这些只是关于如何提高代码可读性的简单提示。

【讨论】:

  • 谢谢,考虑到这一点,我很高兴。谢谢。
  • 那么整个网页的文档或者word文档中的模板呢?万一客户要求,你会怎么做?
  • 取决于项目。我建议写一篇自述文本,解释不同的元素及其 css 类。如果您“仅”使用 html 和 css,我不会担心其他开发人员。这些是非常基本的。对于其他开发人员来说,重要的是您是否会使用像 bootstrap 这样的 CSS 框架。当您应该在自述文件中放置框架文档的链接时。您可能使用的任何 js 或 jquery 插件也是如此。如果您觉得我的回答足够好,请将其标记为正确或标记为有用。
  • 你能告诉我如果它是一个像 bootstrap 这样的 css 框架吗
  • Bootstrap 是 css 类和一些 javascript 组件的集合。它在构建响应式网站时特别有用。他们的文档包含您需要知道的所有内容getbootstrap.com。我个人在每个项目中都使用它。
猜你喜欢
  • 2018-12-03
  • 2023-03-29
  • 1970-01-01
  • 2015-09-12
  • 2021-01-18
  • 1970-01-01
  • 2022-12-07
  • 2012-05-04
  • 1970-01-01
相关资源
最近更新 更多