草庐IT

Documentation

全部标签

c# - 我应该如何编写 XML 注释以避免在摘要和返回标记之间重复自己?

关闭。这个问题是opinion-based.它目前不接受答案。想要改进这个问题?更新问题,以便editingthispost可以用事实和引用来回答它.关闭4年前。Improvethisquestion当方法的目的是计算一个值并返回它时,我发现自己将其记录如下://////Calculatesthewidgetcount.//////Thecontroltocalculatethewidgetcountof.///Thewidgetcount.这里的returns标签没有提供任何新信息:它只是重复summary中的内容。(异常(exception)是返回bool的方法,其中很容易解释tr

c# - 在哪里可以找到使用中的 C#///xml 文档注释的好示例?

关闭。这个问题不符合StackOverflowguidelines.它目前不接受答案。我们不允许提问寻求书籍、工具、软件库等的推荐。您可以编辑问题,以便用事实和引用来回答。关闭7年前。Improvethisquestion我正在寻找.NETXML样式的源代码注释和所有可用的各种标签的好例子。我在哪里可以找到一些好的例子?

c# - 我在哪里可以找到 C# 3 的深入指南?

关闭。这个问题不符合StackOverflowguidelines.它目前不接受答案。我们不允许提问寻求书籍、工具、软件库等的推荐。您可以编辑问题,以便用事实和引用来回答。关闭5年前。Improvethisquestion似乎C#3在我没有注意到的情况下击中了我,你们能告诉我有关C#3的深入指南吗?从lambda到linq,再到第三版语言引入的所有其他内容。打印书籍会很好,但在线指南会更好!

javascript - 如何使用 JSDoc 记录 ECMA6 类?

背景我在Nodejs中有一个使用ECMA6类的项目,我正在使用JSDoc评论我的代码,以便其他开发人员更容易访问它。但是,我的评论并没有被该工具很好地接受,我的文档也成了废墟。问题我的问题是我不知道如何使用JSDoc记录ECMA6类,而且我找不到任何合适的信息。我尝试了什么我尝试阅读theofficialexample但我发现它缺乏和不完整。我的类有成员、常量变量等等,我通常不知道哪些标签用于什么。我也在网上进行了广泛的搜索,但我发现的大多数信息都是在2015年之前,当时JSDocs还不支持ECMA6脚本。最近的文章很少,不能满足我的需要。我发现的最接近的是这个GitHubIssue:

javascript - _以 "revealing module pattern"样式编写的 JSDoc'ing Javascript 文件的最佳实践?

关闭。这个问题是opinion-based.它目前不接受答案。想要改进这个问题?更新问题,以便editingthispost可以用事实和引用来回答它.关闭4年前。Improvethisquestion我的大多数Javascript函数都相对简单,并且需要它们的副作用:我使用jQuery来操作DOM或进行Ajax调用。我更喜欢以“揭示模块模式”的风格编写我的函数。我justdiscoveredJSDoc-注释Javascript文件有一个好处:在annotations的帮助下,Eclipse的JS开发工具可以解析我的JS文件和filltheEclipseOutlineView(否则将为空

javascript - 使用 jsdoc-toolkit 在命名空间中记录带有原型(prototype)的 javascript 类

我非常努力地使用jsdoc-toolkit以下面的格式记录代码。在我看来,我使用的标签应该会产生所需的结果,但事实并非如此。相反,它警告Class未记录(因为它仅在闭包内定义)并且不在命名空间成员列表中包含Class。如果可能的话,我想在不使用@name标记的情况下记录这一点。谁能帮忙?/***@namespaceTheoriginalnamespace*/varnamespace=function(){//private/***@private*/function_privateMethod(){};/***Thisisthedetailabouttheconstructor*@cl

javascript - Visual Studio 2010 Javascript/jQuery 文档

关闭。这个问题不符合StackOverflowguidelines.它目前不接受答案。我们不允许提问寻求书籍、工具、软件库等的推荐。您可以编辑问题,以便用事实和引用来回答。关闭4年前。Improvethisquestion好的,这里有两个问题:有没有类似GhostDocforJS的东西?是否有任何好的帮助文件生成器可以使用C#和JS源文件来生成文档?看起来SandCaSTLe不支持网站而不是带有.proj文件的Web项目。而且,据我所知,NaturalDocs不支持VisualStudio风格的文档……所以那行不通。我觉得我在这里遗漏了什么。我简直不敢相信外面的人会手动评论他们的JS…

javascript - 如何在 Google map 上突出显示某个区域

如何使用谷歌地图多边形数组突出显示/覆盖一个或多个具有不同颜色的区域(例如美国的3个州)?我在googlecode上找到了一个关于如何绘制多边形的教程,但它没有提供详细信息。感谢您的帮助。 最佳答案 Google上的这份文档尽可能简单明了。http://code.google.com/apis/maps/documentation/javascript/overlays.html查看此页面的来源。将代码复制并粘贴到您自己的页面中,然后从那里开始。http://code.google.com/apis/maps/documentati

javascript - 使用井号/井号引用 javascript 实例方法

这个问题类似于WhyaremethodsinRubydocumentationprecededbyahashsign?我理解为什么在Ruby中实例方法以井号开头,有助于区分谈论SomeClass#someMethod和SomeObject.someMethod并允许rdoc工作。我知道PrototypeJS的作者很欣赏Ruby(有充分的理由)所以他们使用hashmarkconventionintheirdocumentation.我的问题是:这是JavaScript开发人员的标准做法,还是只是原型(prototype)开发人员这样做?换个方式问,我在注释/文档中将实例方法称为SomeC

javascript - 如何在 Visual Studio Intellisense 中记录 JavaScript 配置对象

我一直在使用VisualStudio的JavaScriptIntellisensefunctionality一段时间以来,我对它为标准API提供建议的效果非常满意,但我发现我无法让VisualStudio理解配置对象(即具有多个可选或必需属性的单个对象作为函数的参数).officialJSDocsyntax建议如果期望参数具有属性,则为每个参数创建一个单独的@param行并使用点表示法:/***@param{Object}config*@param{String}config.name*@param{Number}config.gold*/functiondo_it(config){.