函数/方法的主题注释命名答案

【问题标题】：topic-comment naming of functions/methods函数/方法的主题注释命名
【发布时间】：2011-06-02 07:00:04
【问题描述】：

前几天我在看美国手语……我注意到语言的结构是主题评论。就像“天气很好”一样。这让我开始思考为什么我们以以下方式命名方法/函数：

function getName() { ... }
function setName(v) { ... }

如果我们考虑在主题评论函数中命名，函数名称将是

function nameGet() { ... }
function nameSet() { ... }

这对于具有多种用途的类可能会更好。即：

class events {
    function ListAdd();
    function ListDelete();
    function ListGet();

    function EventAdd();
    function EventDelete();
    function EventGet();
}

这样，功能按“主题”分组。与以前的命名一样，函数是按动作名词分组的，但按名词排序。

我认为这是一个有趣的 POV，其他人如何看待命名函数/方法 Topic-Comment？

显然，在同一个项目中混合命名约定会很奇怪，但总的来说呢？

【问题讨论】：

标签： oop programming-languages naming-conventions

【解决方案1】：

现代 OOP 技术应该使我们不必指定函数的主题，而只需要指定动作，例如。

您的事件类应该只有 add/delete/get，并且您应该有一个单独的 Event_List 类也应该有 add/delete/get。

所以，根据语言，它会被称为event_obj.get()，或event_obj.delete()...等等。

喜欢event_list_obj.add()等...

这实际上与您所说的手语一致，这是一个非常好的观点。

【讨论】：

【解决方案2】：

我要大胆猜测一下，您的事件类应该有一个“列表”对象，该对象具有添加、获取和删除以及它自己的添加、获取和删除。当您看到类的名称在其方法中重复时，我发现它是多余的。

【讨论】：

其实应该是反过来的，应该有一个List类来实例化新的事件对象，即列表中的项。
关于冗余的评论是一个非常好的评论，我一直在有机地增长（根据需要添加）一个对象，这是一个很好的提醒，我需要拆分它。