减少编程

Question

有时为了使变量/方法/类名称具有描述性,我需要使其更长.但我不想,我想要有易于阅读的短名称.所以我想到了像Visual Studio这样的IDE的特殊插件,能够为类,方法,字段编写短名称,但能够附加长名称.如果你需要 - 你可以做到这一切,或者你可以长单名.如果你想减少它 - 使用减少,就像两个相同代码的视图一样.我想知道其他人在想什么？你觉得它有用吗？有人会使用那种插件吗？

Answer 1

为什么不使用Visual Studio中内置的标准XML注释系统.如果在类/方法/变量等上面键入///,它会创建注释存根.这些注释通过Intelisense/Code Completion弹出,并提供额外信息.

这样,您可以在评论代码时保持命名约定的简洁性和描述性.您可以运行一个流程,然后使用这些注释为您的代码创建文档.

请参阅:http://msdn.microsoft.com/en-us/magazine/cc302121.aspx

Answer 2

变量名称应该尽可能长,以使其可识别,如果它比您想要的长一点是否重要？只要代码是可读和可理解的,这肯定没有区别？

对于名称太长而无法用作变量/类名称的注释使用注释.这将更合适.

如果方法名称太长,那么它不应该是单个方法...

我不会像这样使用插件.

Answer 3

我从不担心长名.如果方法名称变得太长,它也可能表明该方法做得太多(除非它恰好包含一个非常长的单词).另一方面,我也尽量避免重复自己.我不会Account.AccountId,例如,而是Account.Id.我也依靠命名空间; 如果命名空间清楚我所在的域名,我通常会尝试在类名或成员名称中重复.

底线; 我看不到自己使用这样的插件.