标签: documentation

我正在寻找C中所有语法和内置函数的文档,但我找不到任何在线网站,这似乎是标准C知识的终极官方来源.

除了Kernighan和Ritchie的着名书籍外,是否有任何在线C规范？也许有,我不知道如何找到它.或许问题是我不知道我在找什么.

我正在开发一个C#项目,VisualAssist /// <summary></summary>为我生成这些花哨的评论,我一直在使用它们来记录我的代码.

我假设必须有一种方法可以使用这些注释来创建像Doxygen或Javadoc那样的HTML文档.我怎么做？

我正在接管一个商业网站的开发.该网站由另一位程序员开发了两年多.这主要是一个人的工作(维护和扩展网站).当其他程序员向我展示系统时,我将有2-3天的过渡期.但据我所知,文件很少.一切都在代码中(这是一种记录).以下是我计划到目前为止要问的内容:

• 解释系统中最复杂的元素
• 整体架构的描述
• 支持工具的说明(IDE设置,单元测试,部署机制)
• 他用来影响系统架构的任何书籍,网站和播客

我还缺少其他任何东西？

[编辑]谢谢大家.失去了好的主张.我希望我能接受不止一个答案!另外,我还要补充:

• 你有什么专门为提高系统性能而做的,现在瓶颈在哪里？
• 与此相关,您对系统的安全性做了什么？(你做了什么,现在安全漏洞在哪里)

最后一件事:开发人员说,如果我需要,他可以在以后回答我的问题.毕竟这是他的"宝贝".但我真的认为在6个月内他会继续前进,他的可用性将会大大降低!

我听说jQuery UI包含一个拾色器,但可以找到很少的文档.

它存在吗？

关于如何实施它的任何体面的文件？

我发现了这个:http://docs.jquery.com/UI/Colorpicker

但使用:

$("#colorpicker").colorpicker();

不起作用,Firebug告诉我.colorpicker();不是一种方法!

它似乎工作正常,除非我把它放在一个对话用户界面,然后决定打破.

在Python中记录类或方法很容易:

class Something:
  """ Description of the class. """

  def do_it(self):
    """ Description of the method. """
    pass

  class_variable = 1 # How to comment?

  @property
  def give_me_some_special_dict(self):
    """ doesn't work! Doc of general dict will be shown. """
    return {}

但是如何在API文档中记录字段或属性以供使用help？

我将很快设计一个RESTful API,因此我需要对其进行描述,以便让其他人开始使用它来实现客户端.

我看了一下,但不幸的是,我没有找到任何描述基于Web的RESTful服务的标准化形式.我正在寻找的东西就像JavaDoc,虽然它不必由任何类型的代码生成.我也不是在谈论类似WADL的东西,我宁愿想要一些我可以提供的人类可读的文档.

由于RESTful基于Web的服务的性质,标准化文档应该很容易.它应该只列出可用的资源,相应的URI,允许的方法,内容类型并描述可用的操作.你有什么建议吗？

在此先感谢您和Greets

我正在使用Visual Studio 2010 Ultimate在C++中编程.我想记录一些函数,我希望文档显示在Intellisense中.

根据MSDN,我只需要在声明之前或之后将注释放在同一行.所以我尝试了这个:

// This is a test.
void foo();
void bar() { foo(); }

将鼠标移动时foo(),注释不会出现在工具提示中.我也尝试过:

• ///
• <summary></summary> 标签
• 构建/doc(通过在项目设置中设置"生成XML文档文件"选项)

到目前为止我没有运气.有没有人知道如何使这项工作？

项目文件(要求等)应该在哪里存储在典型的maven项目中.

"标准目录布局"页面简介中列出的目录都不是明显的候选对象.

我很快就开始了一个开源Python项目,我正在尝试提前决定如何编写我的文档字符串.显而易见的答案是使用reStructuredText和Sphinx与autodoc,因为我真的喜欢简单地在我的文档字符串中正确记录我的代码然后让Sphinx为我自动构建API文档.

问题是它使用的reStructuredText语法 - 我认为它在呈现之前是完全不可读的.例如:

:param path: The path of the file to wrap
:type path: str
:param field_storage: The :class:`FileStorage` instance to wrap
:type field_storage: FileStorage
:param temporary: Whether or not to delete the file when the File instance
    is destructed
:type temporary: bool

你必须真正放慢脚步,花一点时间才能理解这种语法混乱.我更喜欢谷歌方式(谷歌Python风格指南),与上面的对应方式如下:

Args:
    path (str): The path of the file to wrap
    field_storage (FileStorage): The FileStorage instance to wrap
    temporary (bool): Whether or not to delete the file when the File …

我们可以使用这个链接来add a new event对Google Calendar通过parameters

https://www.google.com/calendar/render?
action=TEMPLATE&
text=EventName&
dates=20131206T050000Z/20131208T060000Z
&location=EventLocation&
sprop=name:Name&
sprop=website:EventWebite&
details=EventDetail&
sf=true&
output=xml

但我找不到有关这些参数的任何文档.

有谁知道它在哪里？