- public IEnumerable<GitHubUser> FavoritesList()
这还不敷。它没有告诉我任何信息。
- public IEnumerable<GitHubUser> FavouriteGitHubUsers()
好点了……不过 GitHub 上并没有 favorites 的概念。只有一个 followed users 的概念。
- public IEnumerable<GitHubUser> FollowedGitHubUsers()
精确的定名函数并把它作为商务说话的简单解释是很重要滴。 范畴驱动设计专家可能会称之”通俗易懂“的沟通。
“收藏”这个词会使混迹 GitHub 的老鸟把它和其他器械混淆。这种混淆会造成时光的浪费,换言之,就是浪费金钱。不要去创造新的说法,当你须要“惹人”新词或新说法时,多评论辩论下,问问该范畴的专家和小伙伴们。
或许已经有一个合适该函数的名称或者些许代码。像我们号令的一样,力争创造简短的代码,我们还应当包管我们范畴词汇的同一,简洁,以及通俗易懂。
我曾为一个同伙做过一个简单的代码审查(备注:下面是 C# 代码)
无参的函数
对我来说,没有参数的函数是一个不和模式。这可能在某些情况下有效,但这些情况异常罕有,重要与已经不完全的设计架构有关。
纯函数是一个如许的函数:个中返回值仅由其输入值肯定,而没有其他可不雅察到的副感化。这是在数学中的函数若何工作的道理。对于雷同的 x 值,Math.cos(x)将始终返回雷同的结不雅。
因为 cookie 中的全局状况和对 HTTPContext 的依附,当前函数不是纯函数。我同伙曾测验测验将该逻辑隐蔽在 CookieHelper 中来拜访它们,但这还不敷。 问题依然存在。
在 Asp.NET 中,在函数之外应用 HTTPContext。它不该该泄漏到琅绫擎。当前代码不克不及在不合的高低文中工作。如不雅我们在没有全局的 HTTPContext 的过程中履行它,它将崩溃。
这里还有另一个反模式,新的关键字。测验测验注入尽可能多的器械。 这个建议可能被不精确地应用,但依附仍不容忽视。
纯函数是一个很好的概念; 这是我在摸索函数式编程时学到的。
细心看看代码,个中包含 CookieHelper 许可拜访 myCookie.ID 的逻辑。 我们可以经由过程惹人一个包含参数 ID 的函数来大年夜这个函数中移除所有这些逻辑。
- public IEnumerable<GitHubUser> FollowedGitHubUsers(int cookieId)
我们不在乎 cookieId 的值来自哪里。这给出了更多的选择,因为我们可以大年夜其他源获取 cookieId,而不仅仅是大年夜 cookie 中。
更改后的代码
- public IEnumerable < GitHubUser > FollowedGitHubUsers(int userId) {
- List < GitHubUser > favoritesList = new List < GitHubUser > ();
- using(var db = new GitHubContext()) {
- var results = (from ch in db.CookiesHistory where ch.UserId == userId select new {
- GitUserId = ch.GitUserId
- });
- foreach(var result in results) {
- var user = (from u in db.GitUsers where u.Id == result.GitUserId
推荐阅读
【51CTO.com快译】众所周知,应用GUN/Linux体系的安然性要比微软windows赶过不少,但这并不料味着应用GUN/Linux就万无一掉。用户对体系安然越来越高的请求,正促使着体系套件的推想出新,>>>详细阅读
本文标题:记一次C#代码审查
地址:http://www.17bianji.com/lsqh/35240.html
1/2 1

网友点评
精彩导读
科技快报
品牌展示