Lines Matching refs:comments
18 .. note:: Conventions on comments and documentation are not checked by
45 "Normal" comments (i.e. ``//``, rather than code documentation which starts
47 comments are, even though they will not be rendered. This improves consistency,
49 comments more easily. For instance:
56 Furthermore, just like documentation, comments are capitalized at the beginning
58 includes ``// SAFETY:``, ``// TODO:`` and other "tagged" comments, e.g.:
64 Comments should not be used for documentation purposes: comments are intended
67 sometimes it is useful to use both comments and documentation at the same time.
69 For the latter case, comments can be inserted in the middle; that is, closer to
70 the line of documentation to be commented. For any other case, comments are
88 One special kind of comments are the ``// SAFETY:`` comments. These must appear
97 ``// SAFETY:`` comments are not to be confused with the ``# Safety`` sections
100 comments show why a call (for functions) or implementation (for traits) actually
171 writing these comments is not just a good way of documenting what has been