---
title: "Enhanced inline markdown commenting in Google Apps Script functions using JSDoc"
author: "Martin Hawksey"
date: 2022-07-28T21:04:56+00:00
canonical_url: https://pulse.appsscript.info/p/2022/07/enhanced-inline-markdown-commenting-in-google-apps-script-functions-using-jsdoc/
markdown_url: https://pulse.appsscript.info/p/2022/07/enhanced-inline-markdown-commenting-in-google-apps-script-functions-using-jsdoc.md
categories:
  - "Intermediate"
  - "Solutions"
tags:
  - "tanaikech.github.io"
featured_image: https://pulse.appsscript.info/files/2022/07/fig2.png
description: "Another useful discovery from Kanshi Tanaike this time highlighting the ability to use markdown in Google Apps Script code comments. For those unfamiliar, JSDoc is the syntax used to automatically generate inline documentation in Google Sheets custom functions, Libraries as well as function references in your script project. As highlighted in the post as well as being able to add @constructor tags, developers can use markdown syntax to provide additional formatting to documentation comments. See the source post for details of supported markdown syntax."
---

# Enhanced inline markdown commenting in Google Apps Script functions using JSDoc

![Enhanced inline markdown commenting in Google Apps Script functions using JSDoc](https://pulse.appsscript.info/files/2022/07/fig2.png)

> [https://tanaikech.github.io/2022/07/20/report-documentation-comments-including-jsdoc-for-functions-of-google-apps-script/](https://tanaikech.github.io/2022/07/20/report-documentation-comments-including-jsdoc-for-functions-of-google-apps-script/)

Another useful discovery from Kanshi Tanaike this time highlighting the ability to use markdown in Google Apps Script code comments. For those unfamiliar, [JSDoc**](https://jsdoc.app/about-getting-started.html) is the syntax used to automatically generate inline documentation in [Google Sheets custom functions,**](https://developers.google.com/apps-script/guides/sheets/functions#autocomplete) [Libraries**](https://developers.google.com/apps-script/guides/libraries#best_practices) as well as function references in your script project. As highlighted in the post as well as being able to add `@constructor` tags, developers can use markdown syntax to provide additional formatting to documentation comments. See the source post for details of supported markdown syntax.

Source: [Report: Documentation Comments including JsDoc for Functions of Google Apps Script**](https://tanaikech.github.io/2022/07/20/report-documentation-comments-including-jsdoc-for-functions-of-google-apps-script/)

---

*Published by [Martin Hawksey](https://pulse.appsscript.info/p/author/admin/) on [Pulse](https://pulse.appsscript.info/). Original article: [https://pulse.appsscript.info/p/2022/07/enhanced-inline-markdown-commenting-in-google-apps-script-functions-using-jsdoc/](https://pulse.appsscript.info/p/2022/07/enhanced-inline-markdown-commenting-in-google-apps-script-functions-using-jsdoc/)*
