> For the complete documentation index, see [llms.txt](https://boxlang.ortusbooks.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://boxlang.ortusbooks.com/boxlang-+-++/modules/bx-spreadsheet/built-in-functions/spreadsheetsetcellcomment.md).

# SpreadsheetSetCellComment

Sets a comment on a cell in a spreadsheet.

## Method Signature

```
SpreadsheetSetCellComment(spreadsheetObj=[any], comment=[any], row=[any], column=[any], author=[any])
```

### Arguments

| Argument         | Type      | Required | Description                                                             | Default |
| ---------------- | --------- | -------- | ----------------------------------------------------------------------- | ------- |
| `spreadsheetObj` | `ANY`     | `true`   | The spreadsheet object.                                                 |         |
| `comment`        | `ANY`     | `true`   | The comment (String or Struct with formatting options).                 |         |
| `row`            | `NUMERIC` | `true`   | The row number (1-based).                                               |         |
| `column`         | `NUMERIC` | `true`   | The column number (1-based).                                            |         |
| `author`         | `STRING`  | `false`  | The author of the comment (optional, only used if comment is a String). |         |

## Examples

Add a comment to a cell:

```js
// Add note to cell
var spreadsheet = SpreadsheetNew();
SpreadsheetSetCellValue( spreadsheet, 1, 1, "Data" );
SpreadsheetSetCellComment( spreadsheet, 1, 1, "Important: review this value" );
```

Document spreadsheet data:

```js
// Add explanatory comments
var spreadsheet = SpreadsheetNew();
SpreadsheetAddRow( spreadsheet, [ "ProjectID", "Status", "Progress" ] );
SpreadsheetAddRow( spreadsheet, [ 101, "Active", 0.75 ] );

SpreadsheetSetCellComment( spreadsheet, 1, 2, "Current project status" );
SpreadsheetSetCellComment( spreadsheet, 2, 3, "75% complete as of today" );
```

## Related

* [SpreadsheetGetCellComment()](/boxlang-+-++/modules/bx-spreadsheet/built-in-functions/spreadsheetgetcellcomment.md) - Get comment
* [SpreadsheetSetCellValue()](/boxlang-+-++/modules/bx-spreadsheet/built-in-functions/spreadsheetsetcellvalue.md) - Set cell value
* [SpreadsheetFormatCell()](/boxlang-+-++/modules/bx-spreadsheet/built-in-functions/spreadsheetformatcell.md) - Format cell


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://boxlang.ortusbooks.com/boxlang-+-++/modules/bx-spreadsheet/built-in-functions/spreadsheetsetcellcomment.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.