如何在Visual Studio 2013 C ++中计划编写嵌套类 [英] How to Plan Writing of a Nested Class in Visual Studio 2013 C++

问题描述

基本问题是屏幕宽度和高度都很多，而且随着课程变得越来越复杂，很难将所有内容都计划好。 DOxygen可能在某种程度上可以记录这个过程。



有一次我曾建议将Wordpress用于这样的任务

[ 1 ]。但是，在Windows 7终极环境或在线环境中，它提供了两种选择：要么将所有内容公开，要么使用本地解决方案。如果它是Word-press base，那么安装可能会出现并发症，暂时使其不可行。



现在，我正在寻找一个简单的HTML解决方案。 HTML可以引用多个目录级别。我尝试使用Open Office来保存HTML文件，但输出存在格式问题。



- 现在的临时解决方法是使用在线quackit在线HTML编辑器生成HTML，其中包含记录CCDCDirectControls类的每个级别的表（它是嵌套的，因此有多个级别，可以放在引用为HTML链接的子目录中）在线HTML编辑器 - 完整 [ 2 ]。然后我可以使用Notepad ++ Notepad ++ v6.8.8 - 当前版本 [ 3 ]在本地保存文档。



我可以开始在表格中记录需要编码的不同子类部分的当前状态，以及状态，是否在标题中声明，在标题中定义使用TODO代码，或在C ++代码中完全定义。



作为我之前喜欢的一个例子，有很多可以轻松获得的Magick ++的C ++在线文档在编码之前编写（至少在顶层）并在编码期间或 http://www.imagemagick.org/之后更新Magick ++ / Documentation.html [ 4 ]。



还是有更好的选择吗？建议在编码过程中制作易于阅读的文档（事前，更新期间，然后再参考）？



我听说过一些关于标记很好，但是当我搜索它时，我发现dOxygen似乎可能更好，因为事后代码完成而不是事先计划。有没有人更了解这种方法？

The basic issue is that there is but so much screen width and height, and as a class gets more complicated, it is difficult to plan everything out. DOxygen might work to some extent to document the process.

At one point I had proposed that Wordpress could be used for such a task
[1]. However, in a Windows 7 ultimate environment, or online, that gives two options: either either make everything public or have a local solution. If it is Word-press base, there can be complications with the installation that temporarily make that not feasible.

For now, I am looking at a plain HTML solution. HTML can reference multiple directory levels. I tried using Open Office to save the HTML file, but there are formatting issues with the output.

-So the temporary workaround for now is to use the online quackit Online HTML Editor to generate the HTML with tables that document each level of the CCDCDirectControls class (it is nested, so there are multiple levels, that can be placed in sub-directories referenced as HTML links) Online HTML Editor - Full[2]. And then I can use Notepad++ Notepad++ v6.8.8 - Current Version[3] to save the documentation locally.

I can start documenting in a table what the current status is for the different sub-class portions that need to be coded, and there status, whether they are declared in the header, defined in the header with TODO code, or fully defined in the C++ code.

As an example that I liked previously, there is the C++ online documentation for the Magick++ that could easily have been written (at least at top levels) before coding as well as updated during coding or after http://www.imagemagick.org/Magick++/Documentation.html[4].

Or is there a better option? What is recommended to make easily-readable documentation to follow during the coding process (before-hand, updating during, and then for reference after)?

I heard something about markup being good, but when I searched for it, I found dOxygen which seemed perhaps better for after-the-fact that the code was done rather than planning before hand. Does anyone know more about this approach?

推荐答案

我的提示是依靠DOxygen，因为它是行业领先的工具。代码文档是一个令人烦恼的问题，没有人喜欢，因此它经常缺乏甚至失败。因为代码正在发展多年，所以你需要一个简单的工具来完成很少的工作。



另一种方法可以是继承。使用文档制作公共内容并继承一个没有文档的受保护类。



嵌套类我真的会避免。如果您想要一些许可，请使用名称空间声明。

My tip is to rely on DOxygen, because it is an industry leading tool. Code documentation is an annoying issue which nobody likes, and so it often lacks or even fails. Because code is developing over some years you need a simple tools which makes little work.

Another approach can be inheritance. Make the public stuff WITH documentation and inherite a protected class which got no documentation.

Nested classes I would really avoid. If you wanted some clearance use namespace declarations.

这篇关于如何在Visual Studio 2013 C ++中计划编写嵌套类的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！