commentator 0.2.3

Source code comments extractor binary and SDK
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144


/// Comment specification.
/// Detects comment for different languages.
/// Use implementations:
///  - `Java::new()` - for C-style comment languages (C, C++, Java, Go, Rust, JS, etc)
///  - `Bash::new()` - for `#` comments detector (bash, shell, python, etc)
///  - `HTML::new()` - for markup languages (HTML, XML, etc)
pub trait Spec {
    fn is_begin(&self, src: &str) -> Option<usize>;

    fn is_end(&self, src: &str) -> Option<usize>;

    fn is_inline(&self, src: &str) -> Option<usize>;

    fn trim<'a>(&self, src: &'a str) -> &'a str;
}

pub enum StandardSpec {
    C,
    Rust,
    HTML,
    Bash,
}

impl Spec for StandardSpec {
    fn is_begin(&self, src: &str) -> Option<usize> {
        match self {
            StandardSpec::C => c_is_begin(src),
            StandardSpec::HTML => html_is_begin(src),
            StandardSpec::Rust => c_is_inline(src),
            _ => None,
        }
    }

    fn is_end(&self, src: &str) -> Option<usize> {
        match self {
            StandardSpec::C => c_is_end(src),
            StandardSpec::HTML => html_is_end(src),
            _ => None,
        }
    }

    fn is_inline(&self, src: &str) -> Option<usize> {
        match self {
            StandardSpec::C => c_is_inline(src),
            StandardSpec::Rust => rust_is_inline(src),
            StandardSpec::Bash => bash_is_inline(src),
            _ => None
        }
    }

    fn trim<'a>(&self, src: &'a str) -> &'a str {
        match self {
            StandardSpec::C => c_trim(src),
            StandardSpec::Rust => rust_trim(src),
            StandardSpec::Bash => bash_trim(src),
            _ => src,
        }
    }
}

fn c_is_begin(src: &str) -> Option<usize> {
    if src.starts_with("/**") {
        Some(3)
    } else if src.starts_with("/*") {
        Some(2)
    } else {
        None
    }
}

fn c_is_end(src: &str) -> Option<usize> {
    if src.starts_with("*/") {
        Some(2)
    } else {
        None
    }
}

fn c_is_inline(src: &str) -> Option<usize> {
    if src.starts_with("//") {
        Some(2)
    } else {
        None
    }
}

fn c_trim<'a>(src: &'a str) -> &'a str {
    if src.starts_with("*") {
        src[1..].as_ref()
    } else if src.starts_with("//") {
        src[2..].as_ref()
    } else {
        src
    }
}

fn rust_is_inline(src: &str) -> Option<usize> {
    if src.starts_with("///") || src.starts_with("//!") {
        Some(3)
    } else {
        c_is_inline(src)
    }
}

fn rust_trim<'a>(src: &'a str) -> &'a str {
    if src.starts_with("///") || src.starts_with("//!") {
        src[3..].as_ref()
    } else {
        c_trim(src)
    }
}

fn html_is_begin(src: &str) -> Option<usize> {
    if src.starts_with("<!--") {
        Some(4)
    } else {
        None
    }
}

fn html_is_end(src: &str) -> Option<usize> {
    if src.starts_with("-->") {
        Some(3)
    } else {
        None
    }
}

fn bash_is_inline(src: &str) -> Option<usize> {
    if src.starts_with("#") {
        Some(1)
    } else {
        None
    }
}

fn bash_trim<'a>(src: &'a str) -> &'a str {
    if src.starts_with("#") {
        src[1..].as_ref()
    } else {
        src
    }
}