标签: documentation

有没有人使用其他任何东西来记录他们的PHP代码？PHPDoc? 是否有任何工具可以读取相同的文档语法,但提供更丰富的输出？

我对Doxygen(Mac OS X Snow Leopard上的1.6.1)有一个相当奇怪的问题,因为无论我做什么,它似乎都没有记录我的枚举.我正在用C语言编程并遵循手册中的说明.这是我的代码:

/**
 * \enum dccp_pkt_type 
 * \brief specifies the available DCCP packet types
 */

enum dccp_pkt_type
{
    DCCP_REQUEST    = 0,    /**< DCCP Request Packet */
    DCCP_RESPONSE,          /**< DCCP Response Packet */
    DCCP_DATA,              /**< DCCP Data Packet */
    DCCP_ACK,               /**< DCCP Ack Packet */
    DCCP_DATAACK,           /**< DCCP Data Ack Packet */
    DCCP_CLOSEREQ,          /**< DCCP Close Request Packet */
    DCCP_CLOSE,             /**< DCCP Close Packet */
    DCCP_RESET,             /**< DCCP Reset Packet */
    DCCP_SYNC,              /**< DCCP Sync Packet */
    DCCP_SYNCACK, …

在MSDN文档中,我们看到:

安慰

线程安全

这种类型是线程安全的.

的TextWriter

线程安全

此类型的任何公共静态(在Visual Basic中为Shared)成员都是线程安全的.任何实例成员都不保证是线程安全的.

我已经为Console一个开发了一个类似的(静态)类,那么如何将它标记为线程安全呢？我正在提取XML文档,我知道我可以像MSDN Doc那样使用这个部分.

希望我足够清楚......

感谢帮助 !

我不确定我是否正确地调用了这个,但我想开始在我的类,方法,属性等中添加一些文档.我知道这可能是非常明显但我从未真正学过它.我不知道从哪里开始.

只是为了澄清每当你翻转一个类(或方法,属性等)时,它会在Visual Studio中显示一个工具提示,其中包含有关该特定方法的一些文档.

class Microsoft.Phone.BackgroundAudio.BackgroundAudioPlayer
提供对音频播放功能的后台访问,如播放,暂停,快进和快退.

这叫什么,我怎样才能在我的C#应用​​程序中实现它？

我有一个设置,可以使用标准REST获取一些资源,这很容易记录在swagger中.当更改后,使用websockets将相同的资源推送到客户端,因此客户端不必在间隔的基础上进行拉取.

但是我怎么能在招摇中记录下来呢？它甚至可能吗？如果没有,您建议使用什么其他工具来记录REST API和websocket部分？

据我所知，Docusaurus 支持自定义页面，但是有没有办法在一个 Docusaurus 项目中拥有两个文档？

原始导航栏项目有：

• 文档
• 博客
• ...

我想要这样的东西：

• 文件1
• 文件2
• 博客
• ...

我知道我可以在一个文档中创建许多子文件夹，但出于某种原因，我想要一个两个文档结构，这为我提供了一种更清晰的方式来访问文档。

如果Docusaurus目前无法提供此功能，我想问一下是否有其他文档框架提供此功能？

我正在寻找关于Javascript引擎内部的书籍/文章/论文,以及关于JVM内部,CLR内部等的许多参考书.我可以(并且可能会)查看JavaScriptCore和V8/Chromium的源代码,但如果那里有一本书或其他"导游"文档,我宁愿先阅读它们.谢谢.

所以我正在使用WCF,并希望记录我的界面和服务,以便为另一家公司提供内部应用程序.记录这些界面的最佳方法是什么？我更喜欢将文档与代码内联,然后对输出HTML有一些美化,但我不确定是否有推荐的方法来实现它.

我负责找到一个很好的方法来记录我正在进行的软件项目.

记录哪些内容很重要？代码和设计的文档是否应该以注释的形式出现在代码中？我们应该将文本文件或Word文档直接放在源代码控制中以便与代码一起使用吗？我们应该使用维基吗？

要考虑的因素包括当前团队创建文档的难易程度,以及其他开发人员以后查找,更正和扩展文档的难易程度.我从许多项目中获得的经验是开发人员倾向于不编写文档,因为编写文档的系统过于复杂或开发人员不友好,而且几年之后,新开发人员很难找到编写的小文档.

我对您在类似项目中使用的方法感兴趣.什么运作良好,什么运作不好,为什么？

关于该项目的一些关键事实:

• 该平台是C#和.NET.
• 我们使用Visual Studio和Team Foundation Server进行源代码管理和工作项(任务)管理.
• 我们使用Scrum和测试驱动的开发,并受到域驱动设计的启发.
• 该软件包含一组Web服务和两个GUI客户端.
• 其他客户将来会与Web服务集成.集成将由其他团队的其他开发人员完成(因此Web服务形成一种API).
• SharePoint在整个开发环境中被大量使用.大多数项目都有SharePoint站点,包括我们的站点.
• 在我们项目的SharePoint网站上,我们目前有大量关于需求,设计,利益相关者演示等内容的MS Office文档.保持最新状态很难.
• 我们还为开发团队提供了一个SharePoint wiki,我们在这里以非结构化的方式记录事物.示例包括我们的构建脚本是如何组织的,我们的测试策略,编码指南.
• 该软件是一个相当大的金融机构的内部应用程序.
• 该软件由一个由6人组成的团队在约1年的时间内开发.
• 开发人员只是为此项目雇用的顾问,将来无法提供帮助(除非客户决定支付费用).
• 客户对如何记录此类项目的指导方针很少.

过去在这个主题上有几个主题,声称Sphinx根本不支持这个.我有疑虑,但要么它已经更新,或者它的文档被很好地隐藏了,因为这里有一个链接在网站上另外说明: http://sphinx.pocoo.org/latest/domains.html#array:牛逼:::标-operatorC

无论如何,我是Sphinx的新手,但我正在尝试使用它(最终)使用来自某些源C++代码的一些文本来自动化文档.到目前为止,当使用sphinx-apidoc -o .......命令时,我无法到达任何地方.创建了几乎空白的文档.我可能没有使用正确的指令,因为我不知道如何 - 支持文档无法帮助我.

任何人都可以提供一些帮助来完成它的工作所需的基本步骤吗？如果无法从C++自动生成文档,那么C++域是什么以及如何使用它们？