Tag: 代码文档

用XML注释loggingC＃代码的最佳实践是什么？

我正在通过一些我刚刚写的新代码，并将NDoc sytle注释添加到我的类和方法中。 我希望能够生成一个非常好的MSDN样式文档以供参考。 一般来说，在为一个class级和一个方法写评论时有什么好的指导方针？ NDoc评论应该说什么？ 他们不应该说什么？ 我发现自己在看.NET框架的评论是什么，但是这个速度太快了; 如果我能有一些好的规则来指导自己，我可以更快地完成文档。

如何在有限的可能值jsdoc中logging一个stringtypes

我有一个接受一个string参数的函数。 该参数只能有一个定义的可能值。 什么是最好的方式来logging相同的？ 应该shapeType定义为枚举或TypeDef或别的东西？ Shape.prototype.create = function (shapeType) { // shapeType can be "rect", "circle" or "ellipse"… this.type = shapeType; }; Shape.prototype.getType = function (shapeType) { // shapeType can be "rect", "circle" or "ellipse"… return this.type; }; 问题的第二部分是在定义shapeType的文件中不知道shapeType的可能值。 有几个开发人员可能会添加到shapeType的可能值的多个文件。 PS：我正在使用jsdoc3

JSDoc：返回对象结构

我怎么能告诉JSDoc有关返回的对象的结构。 我find了@return {{field1: type, field2: type, …}} description语法，并试过了： /** * Returns a coordinate from a given mouse or touch event * @param {TouchEvent|MouseEvent|jQuery.Event} e * A valid mouse or touch event or a jQuery event wrapping such an * event. * @param {string} [type="page"] * A string representing the type of location that should be […]

loggingNode.js项目

我目前正在使用JSDoc工具包来logging我的代码，但是它不太适合 – 也就是说，它似乎很难正确描述名称空间。 假设你的每个文件都有两个简单的类： lib/database/foo.js ： /** @class */ function Foo(…) {…} /** @function … */ Foo.prototype.init(…, cb) { return cb(null, …); }; module.exports = foo; 然后inheritancelib/database/bar.js ： var Foo = require('./foo'); /** * @class * @augments Foo */ function Bar(….) {…} util.inherits(Bar, Foo); Bar.prototype.moreInit(…, cb) { return cb(null, …); }; 在生成的文档中，这只是作为Foo和Bar输出，没有领先的database （或lib.database ），当您没有全局范围内的所有内容时，这是非常必要的。 我已经尝试过抛出@namespace […]

是否有可能将由SandCastle创build的两个页面合并成一个主页面？

对于项目中的每个class级，SandCastle都会创build（其中包括）两个页面： 主页面，称为T_class_full_name ，带有说明，语法，inheritance层次结构和另请参见 成员页面，称为AllMembers_T_class_full_name ，带有构造函数，方法，字段等 有没有办法将这两者合并 – members page被添加到主页面？

codestyle; 在注释之前或之后放置javadoc？

我知道这不是最重要的问题，但我只是意识到，我可以在注释之前或之后放置javadoc注释块。 我们希望采用什么作为编码标准？ /** * This is a javadoc comment before the annotation */ @Component public class MyClass { @Autowired /** * This is a javadoc comment after the annotation */ private MyOtherClass other; }