登录
Canvas Best Practice
分类:工具软件 访问:38 下载量:0

软件介绍

更新时间:2025-08-01

Canvas最佳实践指南旨在帮助您构建使用Canvas for TM1的应用,这些应用易于维护并充分利用Canvas的所有功能。本指南涵盖了一些关键原则:

  • 一致性即质量!
  • 可读性比减少按键更重要。
  • 所有名称(变量、类名等)应描述其用途。
  • 对任何不明显的内容进行注释。

目录

  • 通用规则
  • HTML
  • 样式(CSS)
  • JavaScript
  • HTML或控制器中的逻辑?
  • 优化性能

通用规则

  • 使用一致的名称和大小写使您的代码更易于理解。
  • 始终使用/admin控制台中的页面创建器来创建新页面。
  • 它将创建一个HTML页面和JavaScript控制器。
  • 对简单操作使用内联代码。
  • 为更复杂的代码创建$scope函数,以便于调试或在页面中重用。
  • 避免使用$root作用域在页面之间传递参数。
  • 使用状态参数在页面之间传递简单值。
  • 在页面中每次进行选择时更新URL查询参数。这对于PDF创建很重要。
  • 尽可能使用Bootstrap,以保持外观和感觉的一致性,并允许在主题之间切换。
  • 不要使用JQuery,即$(".class")...,而应使用Angular 1指令。JQuery与Angular应用的兼容性不佳。

HTML

  • 所有HTML元素、属性和ID应为小写
  • 在值中使用连字符分隔单词:id="myElement"变为id="my-element"。
  • 使用2个空格作为缩进(VS Code中的默认设置)。
  • 始终在父元素内缩进子块。
  • 使用空行分隔逻辑代码块。
  • 对于具有多个属性的元素,每个属性应放在一行(缩进)上,而不是一行。
  • 元素属性值始终使用双引号。
  • 唯一例外是tm1-elements属性,对于此属性最好使用单引号,以便元素可以用双引号限定。

样式

  • 不要使用元素来布局您的页面。
  • 使用Bootstrap的class="col-md-4"类,使您的页面适应不同的浏览器大小。
  • 使用Bootstrap类对所有可视元素进行样式设置:表格、按钮、输入、选择、标签等。
  • 限制在元素上使用style属性的使用。
  • 如果在两个或多个元素上重复使用特定样式,请将其设为CSS类。
  • 在创建自己的样式之前,尝试使用Bootstrap样式。这将使您可以轻松更改主题。
  • 将特定页面的样式放置在页面顶部的