# 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()](https://boxlang.ortusbooks.com/boxlang-framework/boxlang-plus/modules/bx-spreadsheet/reference/built-in-functions/spreadsheetgetcellcomment) - Get comment
* [SpreadsheetSetCellValue()](https://boxlang.ortusbooks.com/boxlang-framework/boxlang-plus/modules/bx-spreadsheet/reference/built-in-functions/spreadsheetsetcellvalue) - Set cell value
* [SpreadsheetFormatCell()](https://boxlang.ortusbooks.com/boxlang-framework/boxlang-plus/modules/bx-spreadsheet/reference/built-in-functions/spreadsheetformatcell) - Format cell