.d.ts での可視性を制御する tsconfig の stripInternal 設定について
TSConfig の compilerOption に stripInternal という設定があります。 TSConfig Reference #Strip Internal この設定を有効にすると、JSDoc に @internal を指定したコード（クラス、メソッド、変数、関数）がコンパイル時に生成される .d.ts へ出力されなくなります。 これにより、C# や Kotlin の internal、Java の package private のようなアクセス修飾子相当の振る舞いを TypeScript で実現できます。 TypeScript では、export を使ってコンパイル後のモジュールを構成する必要がありますが、モジュール内部に閉じたアクセス制御を行うことはできません。stripInternal を設定することで、モジュール内でのみ公開するコードを明示的に指定できます。
JSDocで型を定義してTypeScriptの恩恵を受ける
普段から TypeScript で開発されているほうならば、TypeScript の恩恵を十分に堪能されていることと思います。 特に私は VS Code のインテリセンスには頼りっぱなしでこれがなければまともにコーディングができない体になってしまいました。 しかし時には、TypeScript という概念が存在しない退屈な世界で開発を行わなけらばならない状況はあるでしょう。私はもはやキーボードでタイピングすることすらままなりません。 そんな JavaScript しか利用できない状況で代替手段となるのが、JSDoc です。JSDoc のアノテーションによって型を付与することによって最低限の支援を受けることができます。 @Type @Type タグを使用すると、TypeScript で型をつけるときと同じように型を宣言できます。
TypeScript without TypeScript -- JSDoc superpowers
One way to think about TypeScript is as a thin layer around JavaScript that adds type annotations. Type annotations that make sure you don’t make any mistakes. The TypeScript team worked hard on making sure that type checking also works with regular JavaScript files. TypeScript’s compiler (tsc) as well as language support in editors like VSCode give you a great developer experience without any com
Type Safe JavaScript with JSDoc
Generally developers believe that you need TypeScript or Flow if you want type safety for JavaScript. This article we will explore a third alternative to achieve those same goals using just JSDoc comments and Visual Studio Code as your editor. Technically, we are going to use TypeScript but not for compiling our code. Instead we’ll use it to check the types of our JavaScript code during code time
Integrating GitBook with JSDoc to Document Your Open Source Project
article.md Integrating GitBook with JSDoc to Document Your Open Source Project Introduction Good documentation should include two distinct elements - a Guide and an API: The Guide builds concepts, providing examples, etc. GitBook is well suited to generate the Guide, supporting a variety of options, using standard Markdown. The API provides low-level specifics, with function signatures, details, e
GitHub - syavorsky/comment-parser: Generic JSDoc-like comment parser.
comment-parser is a library helping to handle Generic JSDoc-style comments. It is language-agnostic – no semantics enforced. You decide what tags are and what they mean. And it can be used with any language supporting /** */ source comments. no dependencies – it is compact and environment-agnostic, can be run on both the server and browser sides highly customizable – with a little code you can dee
GitHub - kegsay/flow-jsdoc: Use JSDoc to represent Flow annotations
This project is looking for maintainers: facebook/flow#5670 (comment) This is a CLI tool to convert JSDoc annotations into standard Flow type annotations. This means: You only need to document your types once: in JSDoc. You can get the benefits of Flow without having to go through a transpiler, and without having to use ugly looking comment syntax. You can do tiny in-line type comments for those f
GitHub - yarax/eslint-plugin-typelint: TypeLint is an ESlint plugin for optional static typing in JavaScript, based on JSDoc.
TypeLint is an ESlint plugin for static type checking in JavaScript, based on JSDoc. Every application manages data, which is usually described in some way. For example: Swagger definitions Redux store (folded reducers) JSON based database schemas (MongoDB, RethinkDB, CouchDB etc) GraphQL schemas Mission of TypeLint is to provide complex type checking, based on already described data structures of
Release the docs!
# Install SassDoc globally npm install sassdoc -g # Run SassDoc on your project sassdoc source/ Already using SassDoc? Upgrade to version 2 right away! SassDoc is to Sass what JSDoc is to JavaScript: a documentation system to build pretty and powerful docs in the blink of an eye. Among other things, SassDoc is: usable out of the box; highly customisable; blazingly fast; fully themable; integrated
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
Add JSDoc Type definitions by Raynos · Pull Request #24 · Raynos/error
GitHub - roman01la/closure-compiler-handbook: How to use Google's Closure Compiler
Release JSDoc 3.5.0 · jsdoc/jsdoc
GitHub - gajus/babel-plugin-log-deprecated: Adds a console.warn statement to the functions annotated with @deprecated tag.
GitHub - jumpinjackie/jsdoc-typescript-plugin: Experimental JSDoc plugin to generate TypeScript definition files (.d.ts) from JSDoc-annotated source
GitHub - clenemt/docdash: :zap: Lodash inspired JSDoc 3 template/theme
Security Akademeia【セキュリティアカデメイア】
GitHub - jsdoctypeparser/jsdoctypeparser: Parser module for JsDoc or Closure Compiler format type-annotation.
GitHub - jeromeetienne/babel-plugin-jsdoced: babel plugin which use jsdoc to implement strong typing in javascript
GitHub - gajus/eslint-plugin-jsdoc: JSDoc specific linting rules for ESLint.
Doclets - Simplifying Documentation for Developers
