新到一家互联网公司,昨天第一次提交代码,遇到了不少问题,而且大多数是代码格式问题,特此将范的错误记录下来,自我警示。
1. 代码对齐,这个虽然一直也都在注意,不过还是有一行代码没有对齐,以后注意吧,提交前一定要先检查一下。
2. 多余的空格,在代码编写的过程中,会不经意间,多敲几下Space键,用VS的时候也看不出来,但是一旦提交到SVN上面,就会显示红色。
3. 之前的公司喜欢将一些暂时用不到的代码注释掉,但是目前的boss,喜欢清清爽爽,注释掉的代码全部清除。
4. 多余的空行,之前不同功能代码间喜欢用空行分隔,多一行少一行也感觉没有什么,目前是必须一行。
5. 每个类,每个接口多多少少都会引入命名空间,代码提交前需要将多余的命名空间清除,其他的进行排序。
6. 代码编写时尽量避免头重脚轻。
7. 参考别人的代码,要符合自己的情景,包括功能、变量命名,条件........
8. 注释双斜杠后面要空一格。
9. 代码要简单实用,效率高。
10.编写软件的帮助文档,一定要对各个参数解释清楚,包括:具体含义,类型,是必须还是可选,范围等等,给出的示例,一定要和实际相符合。还有一些注意事项。
11.GET、DELETE的BodyStyle=WebMessageBodyStyle.Bare;
PUT、POST的BodyStyle=WebMessageBodyStyle.WrappedRequest;
GET的返回类型与实际需求相关,POST一般返回添加字段的ID,PUT、DELETE一般返回操作结果。
以上是这次代码提交出现的一些错误,谨记,不要再次出现。
时间: 2024-10-11 17:43:53