Lines Matching full:comments

18 .. note:: Conventions on comments and documentation are not checked by
114 empty comment. Thus, at some point, the goal is to remove those comments.
117 Comments  chapter
120 "Normal" comments (i.e. ``//``, rather than code documentation which starts
122 comments are, even though they will not be rendered. This improves consistency,
124 comments more easily. For instance:
131 Furthermore, just like documentation, comments are capitalized at the beginning
133 includes ``// SAFETY:``, ``// TODO:`` and other "tagged" comments, e.g.:
139 Comments should not be used for documentation purposes: comments are intended
142 sometimes it is useful to use both comments and documentation at the same time.
144 For the latter case, comments can be inserted in the middle; that is, closer to
145 the line of documentation to be commented. For any other case, comments are
175 One special kind of comments are the ``// SAFETY:`` comments. These must appear
184 ``// SAFETY:`` comments are not to be confused with the ``# Safety`` sections
187 comments show why a call (for functions) or implementation (for traits) actually
258   writing these comments is not just a good way of documenting what has been