风格与约定 - cynron/pomelo GitHub Wiki

pomelo 有自己的风格以及一些约定，下面对其进行了简单的总结：

• pomelo是一个框架，因此我们在编写的代码都是用来配置框架，以及定义一些被框架进行回调的方法。

• 在pomelo中，无论是component，handler，filter，module，remote等等，它们在导出的时候，往往都会导出一个工厂函数，而不是直接导出对象，这样的话，就能够进行上下文的注入，或者在加载时传入一些配置参数。比起直接导出一个对象，更为灵活好用。在pomelo中也大量使用这种方式。

• pomelo中，很多情况下，框架会从特定的地方读取配置和代码，因此代码组织要遵循pomelo的规范。在game-server/app/servers目录下书写服务器的代码。每一个服务器代码分到两个目录，为handler和remote，分别描述了这个服务器作为接受客户端请求以及作为rpc服务端的逻辑。因此，在pomelo中目录结构很重要。

• pomelo中命名风格基本上与常见的java中命名风格相同。用于创建对象的函数采用全部首字母大写，普通或者对象的方法采用首单词小写字母开头，后面单词大写字母开头，不使用下划线，常量使用全大写，单词间使用下划线隔开。这种风格是非常常见的命名风格。

• 其他，关于编码风格以及编程模式方面,欢迎贡献