极客时J-AI大模型微调训练营(视频+源码+PPT)-无密

极客时J-AI大模型微调训练营(视频+源码+PPT)-无密

下载看水印

请不要将类型或者作用域编进名称中，这增加了解码的负担。

比如团队定义一些规则(成员前缀)：使用_前缀表示危险参数，使用v+数字开头表示业务某版本下的某个属性。

这样会给非本团队或者新加入团队的成员带来更多的阅读负担，除非你有需要。

又或者匈牙利语标记法，许多 Windows 程序员都使用“匈牙利标记法”作为变量命名约定， 这是为了纪念具有传奇色彩的微软程序员 Charles Simonyi。

这种标记法非常简单，其基本原则为： 即变量名（标识符）以一个或者多个小写字母开始，这些字母表示变量的数据型态 ，而我们其实应该避免这样做。

另外，对于使用使用I开头来标记接口，这个因个人或者团队喜好而定义，有人喜欢使用I来标记接口，有人不喜欢这样做，他们或许更喜欢使用Impl来表示实现，所以这个无需争议。

避免思维映射

实际上和上文”不要自造词汇“一个概念，不要让代码的阅读者去理解你的命名是说明含义，而是应该倾向于让阅读者能够直接理解，命名需要语义通达，需要标准普遍。

类名

类名称和对象名称应当是名词或者名词短语，至少不应该是动词。

另外，一个纯的entity类不应该以复数命名，这是不应该的，比如你不应该使用Users来命名一个用户实体类，而是应该在使用它对应的对象时再去表示复数，如查询数据库后返回了一个User列表，此时我们使用类似List或者List类型来存储多个User，此时这个容器才应该命名为users。

避免无意义的词汇，上文已经说过了，Data或者Info这种词汇是不必要的。

对于Manager、Processor这种词汇，只有在贴近业务的用于处理逻辑的类命名中才去使用，当然，也不是所有人都喜欢这样干，主要在于自己或者团队的编码风格与约束规则。

方法名称

方法名称应该是动词或者动词短语，如queryUserByName、saveUser或postPayment，尽可能标准的描述行为与动作。

对于构造函数，可以的话，也可以尝试将默认构造器私有，使用一个纯粹的方法名称来构造对象，如：new Object(user) 不如禁止直接使用new Object，同时向外部抛出 Class.buildFromUser(user)，这样构造更加清晰明了。