Welcome to Software Development on Codidact!

Will you help us build our independent community of developers helping developers? We're small and trying to grow. We welcome questions about all aspects of software development, from design to code to QA and more. Got questions? Got answers? Got code you'd like someone to review? Please join us.

Post History

57%

+2 −1

Q&A Proper location of docstring on struct with attributes

When documenting a struct with attributes, where does the docstring go? Before or after the attribute(s)? Option 1: /// Does it go here? #[derive(Deserialize, Debug)] pub struct Metadata { ...

1 answer · posted 9mo ago by qohelet‭ · last activity 9mo ago by qohelet‭

Question rust docstrings

#4: Post edited by

Iizuki‭ · 2024-02-23T13:34:00Z (9 months ago)
The final ``` was left visible

Copy Link

Raw

Markdown

Proper location of docstring on struct with attributes

When documenting a struct with attributes, where does the docstring go? Before or after the attribute(s)?
Option 1:
~~```~~
/// Does it go here?
#[derive(Deserialize, Debug)]
pub struct Metadata {
pub version: f32,
pub contributors: Vec<String>
}
```
Option 2:
~~```~~
#[derive(Deserialize, Debug)]
/// Does it go here?
pub struct Metadata {
pub version: f32,
pub contributors: Vec<String>
}
```
Option 3 (presumably wrong but adding just in case):
~~```~~
#[derive(Deserialize, Debug)]
pub struct Metadata {
/// Does it go here? (I assume this would document `version`,
/// not the struct)
pub version: f32,
pub contributors: Vec<String>
~~}```~~

When documenting a struct with attributes, where does the docstring go? Before or after the attribute(s)?
Option 1:
```rust
/// Does it go here?
#[derive(Deserialize, Debug)]
pub struct Metadata {
pub version: f32,
pub contributors: Vec<String>
}
```
Option 2:
```rust
#[derive(Deserialize, Debug)]
/// Does it go here?
pub struct Metadata {
pub version: f32,
pub contributors: Vec<String>
}
```
Option 3 (presumably wrong but adding just in case):
```rust
#[derive(Deserialize, Debug)]
pub struct Metadata {
/// Does it go here? (I assume this would document `version`,
/// not the struct)
pub version: f32,
pub contributors: Vec<String>
}
```

#3: Post edited by

qohelet‭ · 2024-02-22T16:28:51Z (9 months ago)

Copy Link

Raw

Markdown

When documenting a struct with attributes, where does the docstring go? Before or after the attribute(s)?
Option 1:
```
/// Does it go here?
#[derive(Deserialize, Debug)]
pub struct Metadata {
pub version: f32,
pub contributors: Vec<String>
}
```
Option 2:
```
#[derive(Deserialize, Debug)]
/// Does it go here?
pub struct Metadata {
pub version: f32,
pub contributors: Vec<String>
}
```
~~Option 3:~~
```
#[derive(Deserialize, Debug)]
pub struct Metadata {
/// Does it go here? (I assume this would document `version`,
/// not the struct)
pub version: f32,
pub contributors: Vec<String>
}```

When documenting a struct with attributes, where does the docstring go? Before or after the attribute(s)?
Option 1:
```
/// Does it go here?
#[derive(Deserialize, Debug)]
pub struct Metadata {
pub version: f32,
pub contributors: Vec<String>
}
```
Option 2:
```
#[derive(Deserialize, Debug)]
/// Does it go here?
pub struct Metadata {
pub version: f32,
pub contributors: Vec<String>
}
```
Option 3 (presumably wrong but adding just in case):
```
#[derive(Deserialize, Debug)]
pub struct Metadata {
/// Does it go here? (I assume this would document `version`,
/// not the struct)
pub version: f32,
pub contributors: Vec<String>
}```

#2: Post edited by

qohelet‭ · 2024-02-22T16:26:26Z (9 months ago)
fix formatting

Copy Link

Raw

Markdown

When documenting a struct with attributes, where does the docstring go? Before or after the attribute(s)?
Option 1:
```
/// Does it go here?
#[derive(Deserialize, Debug)]
pub struct Metadata {
pub version: f32,
pub contributors: Vec<String>
~~}```~~
Option 2:
```
#[derive(Deserialize, Debug)]
/// Does it go here?
pub struct Metadata {
pub version: f32,
pub contributors: Vec<String>
~~}```~~
Option 3:
```
#[derive(Deserialize, Debug)]
pub struct Metadata {
/// Does it go here? (I assume this would document `version`,
/// not the struct)
pub version: f32,
pub contributors: Vec<String>
}```

When documenting a struct with attributes, where does the docstring go? Before or after the attribute(s)?
Option 1:
```
/// Does it go here?
#[derive(Deserialize, Debug)]
pub struct Metadata {
pub version: f32,
pub contributors: Vec<String>
}
```
Option 2:
```
#[derive(Deserialize, Debug)]
/// Does it go here?
pub struct Metadata {
pub version: f32,
pub contributors: Vec<String>
}
```
Option 3:
```
#[derive(Deserialize, Debug)]
pub struct Metadata {
/// Does it go here? (I assume this would document `version`,
/// not the struct)
pub version: f32,
pub contributors: Vec<String>
}```

#1: Initial revision by

qohelet‭ · 2024-02-22T16:25:42Z (9 months ago)

Copy Link

Raw

Markdown

Proper location of docstring on struct with attributes

When documenting a struct with attributes, where does the docstring go? Before or after the attribute(s)?

Option 1:

```
/// Does it go here?
#[derive(Deserialize, Debug)]
pub struct Metadata {
    pub version: f32,
    pub contributors: Vec<String>
}```

Option 2:

```
#[derive(Deserialize, Debug)]
/// Does it go here?
pub struct Metadata {
    pub version: f32,
    pub contributors: Vec<String>
}```

Option 3:

```
#[derive(Deserialize, Debug)]
pub struct Metadata {
    /// Does it go here? (I assume this would document `version`, 
    /// not the struct)
    pub version: f32,
    pub contributors: Vec<String>
}```

rust docstrings

Communities

Post History