为了账号安全,请及时绑定邮箱和手机立即绑定

对于开发C#编码标准/最佳实践文档有什么建议吗?

对于开发C#编码标准/最佳实践文档有什么建议吗?

C#
哈士奇WWW 2019-12-07 14:56:46
我是一名应届AI毕业生(大约2年),工作不多。创建基本的C#编码标准文档(主要是因为我是该部门的第一个“采用者”)已由我负责。我想我应该解释一下,我可能是最初级的软件工程师,但是我很期待这个任务,因为我希望我可能能够生产出一半可用的东西。我已经在Internet上进行了相当广泛的搜索,并阅读了有关编码标准文档应包含/不应包含的文章。这似乎是寻求任何建议的好地方。我意识到,我有可能为整个关于“最佳做事方式”的分歧打开大门。我既理解又尊重一个不可否认的事实,即每个程序员都有解决每个任务的首选方法,因此,我不想写任何过于pro脚的命令来扼杀个人才能,而是尝试获得一种通用的方法并达成共识标准(例如命名约定),以帮助使个人代码更具可读性。所以这里....有什么建议吗?有没有?
查看完整描述

3 回答

?
不负相思意

TA贡献1777条经验 获得超10个赞

具有讽刺意味的是,设置实际标准可能很容易。

我的第一个建议是从其他工程师那里获得关于他们应该涵盖的内容以及他们认为重要的准则的建议。实施任何类型的指南都需要一定程度的人员支持。如果您突然在文档上放了一个文档,该文档指定了如何编写代码,那么无论您是最初级的还是高级的,您都会遇到阻力。

提出一组建议后,请将其发送给团队以征询反馈并进行审查。再一次,让人们全力以赴。

可能已经采用了非正式的编码实践(例如,为成员变量加上前缀,驼峰函数名称)。如果存在,并且大多数代码都遵循它,那么它将需要形式化其使用。即使通常建议这样做,采用相反的标准也会引起更多的痛苦。

还值得考虑重构现有代码以满足新的编码标准。这看起来似乎是在浪费时间,但是拥有不符合标准的代码可能会适得其反,因为您将遇到各种风格的混搭。人们是否在某个模块中的代码应该遵循新标准还是遵循现有代码风格方面也陷入了困境。


查看完整回答
反对 回复 2019-12-07
?
翻阅古今

TA贡献1780条经验 获得超5个赞

切勿使用MS(或适用于您的语言的Sun或...)编写自己的编码标准。线索在“标准”一词中,如果每个组织都没有决定自己编写代码,那么世界将更容易编码。谁真的认为每次您更改团队/项目/角色时学习一套新的“标准”都是对任何人的时间的良好利用。您应该做的最大的事情就是总结关键点,但是我建议不要这样做,因为关键的内容因人而异。我想就编码标准提出另外两点

  1. 闭合足够好-只要代码足够接近,更改代码以遵循字母的编码标准是浪费时间。

  2. 如果要更改代码,则不会遵循“本地编码标准”来编写代码,即使新代码看起来像周围的代码。

这两点是我希望每个人都编写看起来相同的代码的现实。


查看完整回答
反对 回复 2019-12-07
  • 3 回答
  • 0 关注
  • 317 浏览

添加回答

举报

0/150
提交
取消
意见反馈 帮助中心 APP下载
官方微信