タグ付けされた質問 「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; }

184 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 

1つの文字列パラメータを受け入れる関数があります。このパラメーターは、いくつかの定義可能な値のうちの1つのみを持つことができます。同じことを文書化する最良の方法は何ですか？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; }; 問題の2番目の部分は、の可能な値が、提案したものとしてshapeType定義shapeTypeされているファイルで不明であるということです。の可能な値に追加する可能性のある複数の開発者によって提供された複数のファイルがありますshapeType。 PS：使用しています jsdoc3

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