- Java 双重比较
- java - 比较器与 Apache BeanComparator
- Objective-C 完成 block 导致额外的方法调用?
- database - RESTful URI 是否应该公开数据库主键?
如何 self 记录在另一个特定库中使用的类型别名?
在下面的示例中,类 User
定义别名 User::type
应该只在类 Library
中引用通过T::type
.
这是图表:-
Library<T>
预期只有 T
定义了某个别名(例如本例中的 T::type
)。
#include <iostream>
class Base{}; //dummy for the sake of example
template<class T>class Library{
Base* t=nullptr;
public: typename T::type getValue(){return static_cast<typename T::type>(t);}
//some complex function, e.g. T::aType::doSomething()
};
在真实案例中,Library<T>
预期的许多别名,例如T::aType
, T::bType
, T::callbackType
等
要使用上述库,::type
必须定义,例如如下:-
class Derived : public Base{}; //dummy for the sake of example
class User{
public: using type=Derived*;//<-- poorly documented
//... other alias e.g. aType=int*, bType=SomeClass*
//... other complex functions
};
这是用法 ( full demo ):-
int main(){
Library<User> lib;
lib.getValue();
std::cout<<"OK"<<std::endl;
}
注意 User::type
确实缺乏 self 证明。
在现实生活中,大多数编码人员——包括设计它的编码人员——忘记了什么 User::type
是为了。
User::type
未在内部引用 User.h
,因此它很容易被一些编码人员随机删除。
我觉得我们心爱的代码从内部腐烂了,我想办法挽救它。
如何 self 记录类型别名以指示它是如何/在何处调用的??
class User{
/** It is used for Library.h */
public: using type=Derived*;
它变得非常快,我仍然更喜欢使用 C++ 语义而不是随机注释。
class User{
/** It is used for Library.h */
public: using LIBRARY_type=Derived*;
很乱
注意:这个问题类似于How to self-document a callback function that is called by template library class? , 但这个是关于 type-def
而那个是关于 callback
.
最佳答案
看来您这里唯一的实际问题是“它是一个容易被某些编码人员随机删除的目标”。
解决这个问题的方法不是沉迷于 self 记录和名称,而是建立同行评审和回归测试。为什么您团队中的编码人员会“随机删除”一些东西并逍遥法外?这需要停止。
您可能可以通过简单的代码注释来避免必须回滚此类更改的管理难题:
/**
* Provided for use by Library.
*/
using type=Derived*;
就是这样。这就是你所需要的。它一点也不“脏”——它告诉其他编码人员为什么存在 type
声明,并且如果有人将其删除,它会像 diff
中的拇指一样突出。然后你可以问他们,“你是如何得出库不再需要这个声明的结论的,为什么删除它值得破坏我们的 API?”
简而言之,这只是人的问题。在名为 type
的成员类型标准库中有大量示例,因此从技术角度来看,您已经在做您应该做的事情。不要试图用能反射(reflect)类型预期用途的名称来硬塞;让名称描述它是什么。 C++ 委员会在 std::move
上犯了同样的错误!
关于c++ - 自文档一个类型别名(typedef)以表明它将在另一个特定类中使用,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/44109929/
我有一个 .sln 文件,里面有几个项目。为了简单起见,让我们称它们为... 项目A 项目B 项目C ...其中 A 是引用 B 和 C 的主要项目。我的目标是更新我的构建脚本,为 ProjectA
我安装了 Magento,我想知道如何生成完整的 API 文档,例如 http://docs.magentocommerce.com/ 上的文档是使用 phpdoc 生成的。 Magento 中是否包
我通常使用jetbrains family ide。在为函数创建文档时非常有用,只需输入 /** 如何在创建文档时创建自定义标签,例如@date标签。 最佳答案 JavaScript、Java: st
我正在尝试使用 jOpenDocument library创建文档。我已经执行了创建电子表格的示例 - 代码编译并运行正常,但当我尝试使用 Excel Office 2012 或 Google Doc
如标题。 有没有介绍HTML DOM构造的图片? 最佳答案 DOM(文档 对象模型)从文档 节点开始。它被称为“根节点”。 观察下面的树(括号中对应的nodeType): [HTMLDocument]
我喜欢 ColdFusion Builder。但我不喜欢帮助只有 CF9 文档。有什么方法可以将其更改为拥有 ColdFusion 8 文档? 最佳答案 http://livedocs.adobe.c
这个问题在这里已经有了答案: What is the consequence of this bit of javascript? (4 个答案) 关闭 9 年前。 我看到一些 jQuery 脚本嵌
我有一个 XML 文件,其中包含需要在 Word 文档中填充的数据。 我需要找到一种方法来定义一个模板,该模板可用作从 XML 文件填充数据并创建输出文档的基线。 我相信有两种方法可以做到这一点。 创
我正在尝试查找有关如何使用 AVAudioEngine 的详细文档。有谁知道我在哪里可以找到它? 我找到了这个,但与文档丰富的 UI 内容相比,它似乎非常简陋。 https://developer.a
我对 Tensorflow 文档越来越感到恼火和沮丧。我在谷歌上搜索了有关 的文档 tf.reshape 我被定向到一个通用页面,例如 here 。我想查看 tf.reshape 的详细信息,而不是整
我正在学习本教程:http://moxleystratton.com/clojure/clojure-tutorial-for-the-non-lisp-programmer 然后遇到了这个片段: u
如何在 swagger 中为对象数组编写文档。这是我的代码,但我不知道如何访问对象数组中的数据。 { "first_name":"Sam", "last_name":"Smith",
是否有针对 Javascript 的 JavaDocs 之类的东西?当我在 netbeans IDE 中按 ctrl+space 时 写javascript,指定对象的javascript文档就出来了
关闭。这个问题不符合Stack Overflow guidelines .它目前不接受答案。 我们不允许提问寻求书籍、工具、软件库等的推荐。您可以编辑问题,以便用事实和引用来回答。 关闭 5 年前。
我需要 JavaScript 中的 heredoc 之类的东西。你对此有什么想法吗?我需要跨浏览器功能。 我发现了这个: heredoc = '\ \ \ zzz\ \
WSDL 文档是包含一系列的,可描述某个 web service 的定义的,简单的 XML 文档 WSDL 文档结构 WSDL 文档用下表这些主要的元素来描述某个 web service 的
是否有 ocropus 的文档? 我正在寻找对以下功能的解释: make_SegmentPageByRAST(): segment() RegionExtractor(): setPageLines(
这个问题在这里已经有了答案: Understanding events and event handlers in C# (13 个回答) 4年前关闭。 我正在使用 NRECO 和 ffmpeg 对视
我正在尝试访问工作服务器以与名为 Spotfire 的应用程序一起使用。我的同事把这个传给我,现在已经休息了几个星期,我对他的建议有意见。 实际上,当我通过 localhost 运行我的 Web 应用
Elm 文档没有给出示例用法,因此很难理解类型规范的含义。在几个地方,我看到“a”用作参数标识符,例如 Platform.Cmd : map : (a -> msg) -> Cmd a -> Cmd
我是一名优秀的程序员,十分优秀!