美国大学Coding Assignment怎么做？代码可读性比“炫技”更重要

　　以前很喜欢写Assignment的时候“炫技”，结果几个月后都看不懂自己写的code。

　　这个缺点改掉后，分数反而更高了，所以 readability（可读性）真的很重要！这期分享一下我平常大概是怎么写Coding Assignment的。当然每个人可能习惯不一样，不过之前这么写分数都不错。

　　美国大学的Coding Assignment、Programming Assignment并不只是看代码能不能运行。具体评分标准还是要以课程的rubric、assignment brief和老师要求为准，但在很多计算机课程中，代码的可读性、命名、结构和documentation都会影响助教或marker理解你的实现。美国高校的课程代码规范中，也普遍强调清晰的变量命名、合理拆分逻辑以及必要的文档说明。

提高Coding Assignment可读性的技巧

Variable Naming

　　不要担心名字很长（当然也不要太夸张），主要是够清楚，尽量避免缩写。

　　写Coding Assignment的时候，变量名、method名和class名最好能够让别人看到名字就大概知道它是干什么的。比如与其大量使用x、data、temp这种看不出具体含义的名字，不如根据变量实际承担的功能来命名。

　　这一点其实不是为了“代码看起来专业”，而是为了让marker能够更快理解你的代码，也方便自己过一段时间回来修改。Princeton、Cornell等计算机课程的代码规范同样强调descriptive naming，即变量和方法的名称应该能够体现它们的用途。

[图片]

Extract Logic

　　把一些重复的code给抽出来变成新的method，这样可以避免code变得又臭又长。

　　尤其是Coding Assignment代码比较长的时候，如果同一段逻辑重复出现很多次，后期修改其中一个地方，很容易出现改了A却忘了改B的问题。把重复或者相对独立的逻辑extract出来，变成一个单独的method，代码结构会更清楚，也更方便debug和后续修改。

　　当然，也不是看到几行代码就一定要extract。简单、短小而且放在当前上下文中很好理解的代码，没有必要为了“看起来高级”强行拆成很多method。

Documentation

　　这个真的很重要，可以帮marker了解你的思路，以后别人也可以更好地复用/拓展你写的部分。

　　这里的documentation也不是让大家给每一行代码都写一大段comment。对于比较简单的代码，清晰的变量名和method本身可能已经足够说明问题；对于比较复杂的算法、设计思路或者不容易直接理解的部分，再补充必要的说明会更有价值。

　　一些大学的Programming Assignment规范也会明确要求documentation，并强调代码说明应该帮助读者理解程序的设计、组织方式以及关键逻辑，而不是简单重复“这一行代码做了什么”。

[图片]

Coding Assignment不是代码越复杂越好

　　还有几点：

　　MoneyPacketProcessor里面其实不应该是static，但是方便解释就这么放了。

　　不一定要全部弄成一行，很少行/容易理解不用extract。重点是够清楚，自己判断一下！

　　这一点其实也是写美国大学Coding Assignment时比较容易踩的坑：为了让代码看起来“高级”，反而把原本简单的问题写得非常复杂。

　　Coding Assignment的重点还是解决assignment要求的问题，并让自己的实现容易被理解、检查和修改。并不是method越多、class越多、代码越复杂，分数就一定越高。相反，一些计算机课程的coding style要求会强调consistent、logical和easy to read的代码结构。

　　所以写完Coding Assignment之后，可以重新从marker的角度看一遍自己的代码：如果一个不熟悉这份代码的人打开文件，能不能比较快地知道每个变量、method以及主要逻辑是在做什么？

　　如果答案是可以，那么基本就达到了readability的目的。

美国大学Coding Assignment怎么检查自己的代码？

　　提交Programming Assignment之前，可以简单检查几个问题：变量和method的命名是否能够表达实际含义；有没有大量重复的code；比较复杂的逻辑有没有必要拆分；关键设计有没有适当的documentation；代码格式和indentation是否统一；最后再对照assignment brief和rubric确认自己没有漏掉老师明确要求的功能或格式。

　　尤其要注意，代码能运行不代表Coding Assignment就一定写得好。有些课程会把code quality、style、documentation甚至测试作为评分的一部分，因此不能只在最后检查程序有没有output，还要检查代码本身是否符合课程要求。

Coding Assignment常见问题

Coding Assignment一定要把代码写得很复杂吗？

　　不需要。复杂度应该服务于问题本身，而不是为了让代码看起来“高级”。如果几行代码就能清楚解决一个简单问题，没有必要为了extract而强行增加method。真正重要的是代码结构合理、逻辑清楚，并且符合课程给出的assignment要求和评分标准。

Variable Naming一定不能使用短变量名吗？

　　也不是。像循环中的i、j这类常见变量名，在合适的上下文中完全可以使用。真正需要避免的是大量没有明确含义的变量名，例如data、temp、x等，让marker无法快速判断变量具体代表什么。

Coding Assignment里的comment是不是越多越好？

　　不是。Documentation的重点是解释代码本身不容易看出来的思路、设计和关键逻辑，而不是给每一行代码翻译成中文。对于简单代码，清晰的命名和结构本身就能够提高可读性；复杂部分再增加必要说明，通常更有效。

Coding Assignment不会做怎么办？

　　如果真正的问题不是代码可读性，而是连assignment要求、算法思路、debug、代码实现或者测试部分都没有理清，就需要先拆分问题。先确认assignment要求和rubric，再确定需要实现的功能、输入输出和核心逻辑，最后再进入具体coding，而不是一上来就开始堆代码。