个人中心
文章发布
退出
作者热门文章
- mongodb - 在 MongoDB mapreduce 中，如何展平值对象？
- javascript - 对象传播与 Object.assign
- html - 输入类型 ="submit"Vs 按钮标签它们可以互换吗？
- sql - 使用 MongoDB 而不是 MS SQL Server 的优缺点
24
4
您认为在 C++ 中创建公共(public)头文件时的最佳做法是什么？
头文件应该不包含、简短或大量的文档吗？我已经看到了从几乎没有文档(依赖于一些外部文档)到不变量、有效参数、返回值等的大型规范的所有内容。我不确定我到底喜欢什么，大型文档很好，因为你总是可以访问它来自您的编辑器，另一方面，带有非常简短文档的头文件通常可以在一两页文本上显示完整的界面，从而更好地概述类可以做什么。
假设我使用简短或大量文档之类的东西。我想要类似于 javadoc 的东西，我在其中记录返回值、参数等。c++ 中最好的约定是什么？据我所知，doxygen 在 java doc 样式文档方面做得很好，但是在使用 javadoc 样式文档之前我应该了解其他任何约定和工具吗？
最佳答案
通常我将接口(interface)的文档(参数、返回值、函数的作用)放在接口(interface)文件(.h)中，并将实现的文档(如何 em> 函数所做的)在实现文件(.c、.cpp、.m)中。
我在声明之前写了一个类的概述，所以读者可以立即获得基本信息。
我使用的工具是 Doxygen。
关于c++ - C/C++ 头文件文档，我们在Stack Overflow上找到一个类似的问题： https://stackoverflow.com/questions/487114/
24
4
0
我有一位客户希望她的网站适合 iPad/iPhone。该网站有一个用 Flash 制作的菜单标题。我使用 Google 的 Swiffy 将文件转换为 flash_1.html 文件。 当网站检测到
我注意到 boost 库使用了 (.hpp) 的头文件。 我很好奇，因为我看到的大多数源文件都使用普通的 .h 头文件。 是否有任何特殊情况需要使用 .hpp 而不是 .h ？ 谢谢 最佳答案 只是约
C需要不同的头文件，如stdio.h、stdlib.h、fcntl.h等，对于不同的函数和结构定义，这是为什么？在幕后，一切都归结为 libc 那么为什么不创建一个包含所有定义和原型(prototyp
我是一名工科学生，不是一个非常强大的程序员。我的一项作业包括使用 openGL 创建 VR 程序。我得到了一个使用 gmtl 的模板(我真的不想重写)标题广泛。该作业需要实现一些 sixense模拟中
我正在尝试编译涉及C和C++文件的应用程序。使用一个特定的 header ，我遇到了问题。有问题的文件(C++头文件)如下所示: #ifndef TASK_H #define TASK_H #incl
我编写了我的项目，将main和c源代码保存在一个文件中，并将头文件保存在codeblocks的include目录中。当我从项目主函数中调用我的函数时，它编译得很好......但是当我将 header
我正在尝试将 .so 库导入到 python 代码中以使用 c 函数。我认为使用 from ctypes import * import ctypes lib = CDLL('./libcaenhvw
我有 2 个重叠的头文件，如下所示: header1.h ... __declspec(dllexport) void abc(); __declspec(dllexport) void xyz(
我有一个大型 Java 库，我想开发几个与该库接口(interface)的较小应用程序。该库将作为 JAR 出现在目标设备的类路径中，但我想尽可能避免在编译时出现整个库(JAR 或源代码)。 (如果重
我必须在我的项目中使用相机制造商提供的库。我正在使用 Visual Studio 2015。我在编写#include 后合并了VS 2015 建议的所有头文件。 我已经在VS 2015中指定了包含文件
我在编写我的项目时遇到了这个问题。我有 2 个 header ，每个 header 都有一个类，它们需要另一个，如下所示。 我以为这只是需要使用前向声明，但仍然不起作用。我没有想法。 寻求帮助:D H
我在一个项目中工作，我想在C++中做反射，所以经过研究我发现最好的方法是解析头文件以获得XML格式的抽象语法树并在反射中使用它。我尝试了很多工具，但没有一个与 visual c++ 2008 或 vi
我尝试从 BufferedImage 制作一个 BMP 文件。这是我尝试在 bmp 文件中写入标题和像素的函数。 我有一个错误，但我找不到那个。我需要你的帮助。 static void writeTo
这个问题在这里已经有了答案: 关闭 10 年前。 Possible Duplicate: undefined reference to `WinMain@16' 我一直在研究循环双链表。决定创建一个
处理这种情况的最佳做法是什么？ class A { private: std::vector derp; public: struct B { ...
上下文:我正在为嵌入式板构建一些代码。它需要安装 Xilinx 工具、Linaro 工具链，然后调用开发板构建目录中的设置 bash 脚本(我们称之为 setup.sh)。 如果我不运行 setup.
我尝试使用头文件和源文件，但遇到了问题。因此，我对我正在尝试做的事情做了一个简化版本，我在 CodeBlocks 中遇到了同样的错误(undefined reference to add(double
当我包含用于将某些程序的整数类型转换为字符串类型的#include 头文件时，我的编译器(GCC for C++)抛出错误。谁能帮我解决这个问题？ 这是一个C++的小代码，我是第一次尝试。 #incl
我的头文件中有一些错误，我不知道如何修复，因为我是 C++ 的新手。 这是头文件的代码: #pragma once typedef unsigned int uint; class DCEncrypt
按照目前的情况，这个问题不适合我们的问答形式。我们希望答案得到事实、引用或专业知识的支持，但这个问题可能会引发辩论、争论、投票或扩展讨论。如果您觉得这个问题可以改进并可能重新打开，visit the
我是一名优秀的程序员,十分优秀！