tsdoc - A doc comment standard for the TypeScript language

  •        145

We are developing a library package @microsoft/tsdoc that provides an open source reference implementation of a parser. Using this library is an easy way to ensure that your tool is 100% compatible with the standard. These are just examples. Many other tools in today's web developer community want to interact with TypeScript doc comments. Each of these tools accepts a syntax that is loosely based on JSDoc, but encounters frustrating incompatibilities when attempting to coexist with other parsers.

https://github.com/Microsoft/tsdoc

Tags
Implementation
License
Platform

   




Related Projects

doctrine - JSDoc parser

  •    Javascript

Doctrine is a JSDoc parser that parses documentation comments from JavaScript (you need to pass in the comment, not a whole JavaScript file). Doctrine can also be used in web browsers using Browserify.

VsDoc2JsDoc

  •    Javascript

The goal of this project is to convert VSDoc JavaScript comments of JayData classes to JSDoc comment format. Using this tool you can generate the API reference of your JayData components and keep your JavaScript documentation up-to-date.

grunt-jsdoc - A grunt plugin to generate javascript doc by running jsdoc3 on your grunt projects.

  •    Javascript

This plugin enables you to integrate the generation of comments based documentation into your Grunt build. This plugin is a wrapper around jsdoc3. Please refer to the documentation for the documentation details.

typescript-eslint-parser - An ESLint custom parser which leverages TypeScript ESTree to allow for ESLint to lint TypeScript source code

  •    Javascript

An ESLint custom parser which leverages TypeScript ESTree to allow for ESLint to lint TypeScript source code. There is sometimes an incorrect assumption that the parser itself is what does everything necessary to facilitate the use of ESLint with TypeScript. In actuality, it is the combination of the parser and one or more plugins which allow you to maximize your usage of ESLint with TypeScript.


swagger2markup - A Swagger to AsciiDoc or Markdown converter to simplify the generation of an up-to-date RESTful API documentation by combining documentation that’s been hand-written with auto-generated API documentation

  •    Java

The primary goal of this project is to simplify the generation of an up-to-date RESTful API documentation by combining documentation that’s been hand-written with auto-generated API documentation produced by Swagger. The result is intended to be an up-to-date, easy-to-read, on- and offline user guide, comparable to GitHub’s API documentation. The output of Swagger2Markup can be used as an alternative to swagger-ui and can be served as static content. NOTE: The Swagger Specification has been donated to to the Open API Initiative (OAI) and has been renamed to the OpenAPI Specification. Swagger2Markup converts a Swagger JSON or YAML file into several AsciiDoc or GitHub Flavored Markdown documents which can be combined with hand-written documentation. The Swagger source file can be located locally or remotely via HTTP. Swagger2Markup supports the Swagger 1.2 and 2.0 specification. Internally it uses the official swagger-parser and my markup-document-builder.

typescript-vs-flowtype - Differences between Flowtype and TypeScript -- syntax and usability

  •    

Both TypeScript and Flow are very similar products and they share most of their syntax with some important differences. In this document I've tried to compile the list of differences and similarities between Flowtype and TypeScript -- specifically the syntax, usage and usability. This document might be incomplete and/or contain mistakes and was last updated to describe TypeScript 3.0 and Flow 0.79.1.

goconfig - Package goconfig is a fully functional and comments-support configuration file (

  •    Go

Package goconfig is a easy-use, comments-support configuration file parser for the Go Programming Language, which provides a structure similar to what you would find on Microsoft Windows INI files. The configuration file consists of sections, led by a [section] header and followed by name:value or name=value entries. Note that leading whitespace is removed from values. The optional values can contain format strings which refer to other values in the same section, or values in a special DEFAULT section. Comments are indicated by ";" or "#"; comments may begin anywhere on a single line.

chevrotain - Parser Building Toolkit for JavaScript

  •    TypeScript

Chevrotain is a blazing fast and feature rich Parser Building Toolkit for JavaScript. It can be used to build parsers/compilers/interpreters for various use cases ranging from simple configuration files, to full fledged programing languages. A more in depth description of Chevrotain can be found in this great article on: Parsing in JavaScript: Tools and Libraries.

documentation.js - Documentation for modern JavaScript

  •    Javascript

documentation.js is a documentation tool for mordern JavaScript. It Supports modern JavaScript: ES5, ES2017, JSX, Vue and Flow type annotations. It provides customizable output: HTML, JSON, Markdown, and more.

dox - JavaScript documentation generator for node using markdown and jsdoc

  •    Javascript

Dox is a JavaScript documentation generator written with node. Dox no longer generates an opinionated structure or style for your docs, it simply gives you a JSON representation, allowing you to use markdown and JSDoc-style tags.This output can then be passed to a template for rendering. Look below at the "Properties" section for details.

vim-jsdoc - Generate JSDoc to your JavaScript code.

  •    Vim

jsdoc.vim generates JSDoc block comments based on a function signature. Depending on your configuration, jsdoc.vim will prompt for description, @return type and description. It will also prompt you for types and descriptions for each function @param.

Visual Log Parser

  •    

Visual LogParser GUI is a free Visual tool for the Microsoft LogParser engine. It enable user to query any log files or data source with an advanced SQL syntax. Visual LogParser offer an dockable MDI interface, color syntax hightlighting, customisation of the log source pro...

visualstudio-docs - This repo is the home of the official Visual Studio, Visual Studio for Mac, Visual Studio Subscriptions, and Scripting Technologies documentation for Microsoft

  •    Python

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments. Welcome! This repo contains source files for the work-in-progress Visual Studio 2017 technical documentation. The topics are published on the Visual Studio documentation site.

BNF Parsersup2;

  •    C++

A universal syntax verification utility utilizing a generic BNF-adaptable parser. The parser is generated at run-time depending on given syntax specification in a Backus-Naur Form (BNF).

react-uwp - 📱⌨️ React Components that Implement Microsoft's UWP Design & Fluent Design.

  •    TypeScript

React Components that Implement Microsoft's UWP Design & Fluent Design System. Visit react-uwp.com online to review the API, see the components in action with live. Or build the documentation to locally.

sql-docs - Technical documentation for Microsoft SQL Server, tools such as SQL Server Management Studio (SSMS) , SQL Server Data Tools (SSDT) etc

  •    PowerShell

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments. You've found the GitHub repository that houses the source for the SQL Server technical documentation published on https://docs.microsoft.com.

gts - ☂️ TypeScript style guide, formatter, and linter.

  •    TypeScript

NOTE: THIS README refers to the master branch which corresponds to the upcoming 1.0 release. To view documentation for the currently released version of this module see: https://github.com/google/gts/tree/v0.9.x. gts is Google's TypeScript style guide, and the configuration for our formatter, linter, and automatic code fixer. No lint rules to edit, no configuration to update, no more bike shedding over syntax.