https://github.com/microsoft/pxt/blob/m ... entions.md
TypeScript原则:
- API和函数通常使用英文的,只有积木显示的字符串可以被翻译。
- 命名空间、函数、函数参数、方法、域都是骆驼拼写法(Camel Case,单词首字母大写),而类、枚举、枚举成员都是大写的。例如:
代码: 全选
namespace myNamespace {
export function myFunction(myParameter: number) {
}
export class MyClass {
myField: number;
myMethod() {
}
}
export enum MyEnum {
MyEnumMember
}
}
- 不要对属性使用“get”(返回参数或属性),如下面函数中,不要使用getTemperature()。
代码: 全选
// not "get temperature"!
export function temperature() {
....
}
- 将所有代码放在命名空间下以避免名称冲突。枚举可以保留在全局命名空间中,名称中包含正确的前缀。
代码: 全选
export enum UniquePrefixMyEnum {
}
namespace myNamespace {
...
}
- 完全拼出单词而不是使用首字母的缩略词。这样虽然名称较长,但这有助于传达API的含义。
代码: 全选
// long but self-explanatory export function doSomethingAwesome() {
}
// not clearexport function dSA() {
}
- 除非使用了首字母缩略词,否则请使用小写。不要用大写方式。
代码: 全选
//% block="foo" export function foo() {
}
- 使用英语编写,并为其他语言环境提供本地化。