Questions tagged «code-documentation»

我知道这不是最重要的问题，但是我刚刚意识到我可以将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; }

183 java  coding-style  annotations  javadoc  code-documentation 

如何将返回的对象的结构告诉JSDoc。我找到了@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 …

144 javascript  documentation-generation  jsdoc  code-documentation  jsdoc3 

我有一个接受一个字符串参数的函数。此参数只能具有几个定义的可能值之一。记录相同内容的最佳方法是什么？应该将shapeType定义为enum还是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

96 google-closure-compiler  google-closure  jsdoc  code-documentation 

对于项目中的每个类，SandCastle都会（其中包括）创建两个页面： 主页称为T_class_full_name，其描述为“语法”，“继承层次结构”和“另请参见”。 成员页面，称为AllMembers_T_class_full_name，带有构造函数，方法，字段等。 有没有办法将这两者合并在一起-将members page其附加到主页上？

68 .net  sandcastle  code-documentation