我能感受到你的痛苦。：/

我希望有一种工具可以与数据字典(描述各种变量/方法名称的文件，我猜有点像javadoc)一起检查源代码，这样你就可以编写这样的代码:

class Battery 
{
   double I; // current
   double T; // temperature
   double V; // voltage
   double Q; // charge

   void update(double Inew, double dt) { I = Inew; Q += I*dt; }
   // ... etc ...
};

and the code-reviewing tool could do a number of different things to make it easier to view code in context, including display reminders that I = current (e.g. in a pane on the right-hand-side of the window it would display variable definitions/semantics/comments for the place in the code you are clicking on), or even allow you to do "virtual refactoring" where as a code reviewer you could rename something to your liking for readability/display reasons without actually changing the code stored on disk.

就像我喜欢自我描述名字一样，我讨厌读像BatteryFilteredCurrentInMilliamps这样的东西。通常在嵌入式系统中，我们是基于代数方程来建模对象的，这样的方程名称非常麻烦。(另一方面，“I”上面有一顶帽子，下标“d”和上标“*”是相当令人困惑的。)

我首先是一个EE /系统工程师，负责少量的软件工作，最后我真的不关心变量的名称，只要我有一种方便的方法来告诉它是什么，并将它映射到我自己的被控制系统的内部模型。

你现在所做的很好，我强烈建议你坚持你当前的语法，是:

语境+动词+ how

我使用这个方法来命名函数/方法，SQL存储过程等。通过保持这种语法，它将使你的智能感知/代码窗格更加整洁。你需要EmployeeGetByID() EmployeeAdd() EmployeeDeleteByID()当您使用更符合语法的语法(如GetEmployee()、AddEmployee())时，您会发现如果在同一个类中有多个get，情况会变得非常混乱，因为不相关的东西会被分组在一起。

我把它比作用日期命名文件，你想说2009-01-07.log而不是1-7-2009.log，因为在你有了一堆之后，顺序就完全没用了。

这也是为什么每个软件开发人员都应该具备写作和沟通技能的另一个原因。

我认为丰富的词汇量也很重要。

这是有编码标准的原因之一。有一个标准往往有助于在需要时想出名字。它有助于解放你的思想，让你去做其他更有趣的事情!(-):

我建议阅读Steve McConnell的《Code Complete》(Amazon链接)的相关章节，其中介绍了一些有助于提高可读性甚至可维护性的规则。

HTH

欢呼,

Rob

为什么不叫HelpDocumentServiceClient有点拗口，或者叫HelpDocumentClient…它是供应商并不重要，重要的是它是处理帮助文档的web服务的客户端。

是的，命名很难。

上个月我刚刚写了一篇关于命名惯例的文章:http://caseysoftware.com/blog/useful-naming-conventions

要点是:

verbAdjectiveNounStructure -结构和形容词作为可选部分

对于动词，我坚持使用动作动词:保存、删除、通知、更新或生成。偶尔，我也会使用“进程”一词，但只是专门指队列或工作积压。

对于名词，我使用与之交互的类或对象。在web2project中，这通常是任务或项目。如果是Javascript与页面交互，则可能是body或table。关键在于代码清楚地描述了与之交互的对象。

该结构是可选的，因为它对该情况是惟一的。列表屏幕可能会请求List或Array。在web2project的项目列表中使用的核心函数之一就是getProjectList。它不修改底层数据，只修改数据的表示形式。

The adjectives are something else entirely. They are used as modifiers to the noun. Something as simple as getOpenProjects might be easily implemented with a getProjects and a switch parameter, but this tends to generate methods which require quite a bit of understanding of the underlying data and/or structure of the object... not necessarily something you want to encourage. By having more explicit and specific functions, you can completely wrap and hide the implementation from the code using it. Isn't that one of the points of OO?