npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

jsdoc-guide

v0.1.1

Published

Guide for jsdoc

Downloads

2

Readme

1. JSDoc

NPM

https://sanghaklee.gitlab.io/jsdoc

TOC

1.1. Usage

1.1.1. Install

$ npm i jsdoc countly-docdash
  • jsdoc: 코드에서 JSDoc 추출하여 정적 사이트 생성
  • countly-docdash: 템플릿

1.1.2. jsdoc.json

현재 프로젝트 jsdoc.json 설명 확인.

아래는 샘플

{
    "tags": {
      "allowUnknownTags": false,
      "dictionaries": ["jsdoc","closure"] 
    },
    "source": {
      "include": "./jsdoc", 
      "includePattern": ".js$", 
      "exclude": ["./docs"], 
      "excludePattern": "(node_modules/|docs)"
    },
    "plugins": [
      "node_modules/jsdoc/plugins/markdown"
    ],
    "markdown":{
        "idInHeadings": true
    },
    "opts": {
      "template": "node_modules/countly-docdash", 
      "encoding": "utf8", 
      "destination": "./docs", 
      "recurse": true, 
      "tutorials": "./tutorials",
      "verbose": true
    },
    "templates": {
      "cleverLinks": true,
      "monospaceLinks": true, 
      "default": {
        "outputSourceFiles": true, 
        "includeDate": false 
      }
    },
    "docdash": { 
      "static": true,
      "sort": false,
      "search": true,
      "collapse": true
    }
}

1.1.3. Generate document from jsdoc

$ jsdoc -c jsdoc.json --readme README.md
  • -c: config 파일 경로
  • --readme: 문서 생성시 README 파일을 포함 (생성된 문서의 Home,index.html)

2. Example

2.1. jsdoc/function.js

2.1.1. @function

* @function

  • Global tagging

2.1.2. {!string}

* @property {!string} path object path

  • Not Null String

2.1.3. {?number}

* @property {?number} code=0 status code

  • Null or Number

2.1.4. {string=}

* @param {string=} encoding=utf-8 file encoding

  • Optional

2.1.5. {?{callback: function}=}

* @param {?{callback: function}=} options={} options

  • Nested Object
 * @param {?{callback: function}=} options={} options
 * @param {function=} options.callback callback function
  • 첫번째 라인에서 전체 오브젝트를 정의한다
    • [@param] [오브젝트 key] [파라미터명] [파라미터 설명]
    • {?{callback: function}=}
      • ? : Nullable
      • = : Optional
      • options={} : default {}
    • options라는 이름을 값는 파라미터는 Null 값이 올 수 있는 Optional한 객체이고 Null일 때 기본값으로 {}을 사용한다. options 객체에는 callback이라는 key의 function 프로퍼티가 존재한다.
  • 두번째 라인에서 오브젝트 프로퍼티를 정의한다.
    • [@param] [프로퍼티 key] [프로퍼티명] [프로퍼티 설명]

2.1.6. @example

사용 예를 나타낸다.

2.1.7. @returns

@return와 같음

리턴 값이 단일 항목이면 아래와 같이 사용한다.

* @returns {string} document

리턴 값이 obcjet이면 @typedef를 이용하여 리턴 객체를 정의하고 사용한다.

/**
 * @typedef User
 * @property {string} name user's name
 * @property {number} age user's age
 */

/**
 * @returns {User}
 */

2.2. jsdoc/class.js

ES6 class 태그를 사용할 땐, @class, @classdesc 사용하지 않는다.

Bad

/**
 * @class User
 * @classdesc User's class
 */
class User {
}

Good

/**
 * Class User's class
 */
class User {
}

3. Docdash