documon
Version:
A documentation system for mortals. Use with any language.
80 lines (56 loc) • 2.37 kB
HTML
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Comments in Comments</title>
<meta name="description" content="more.comment_authoring_guide.comments_in_comments">
<!-- Normalize -->
<link rel="stylesheet" href="assets/vendor/normalize.css">
<!-- prettify -->
<link rel="stylesheet" href="assets/vendor/prettify/codamike.css">
<script src="assets/vendor/prettify/prettify.js"></script>
<!-- Documon Pages Info. (Used by various classes to identify this page.) -->
<script>
var pageCtx = {
id : "more.comment_authoring_guide.comments_in_comments",
name: "Comments in Comments"
}
</script>
<!-- theme
<link rel="stylesheet" href="assets/fonts/Fira_Sans/FiraSans.css">
<link rel="stylesheet" href="assets/fonts/Inconsolata/inconsolata.css">
-->
<link rel="stylesheet" href="assets/css/pages.css">
<script src="assets/js/documon/Storage.js"></script>
<script src="assets/js/documon/Access.js"></script>
<script src="assets/js/documon/Pages.js"></script>
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-106684927-1', 'auto');
ga('send', 'pageview');
</script>
</head>
<body>
<div class="page">
<div class="more"><h1 id="comments-in-comments">Comments in comments</h1>
<p>To include /* style comments in your comments, HTML-entity-ize the slash:</p>
<p>For example to render this:</p>
<pre><code>&#47;**
Something for B
@method something
*&#47;</code></pre>
<p>… you would write:</p>
<p>&#47;**<br />
Something for B<br />
<a href="https://github.com/method">@method</a> something<br />
*&#47;</p>
<p>… because we are HTML encoding the "/" as "&#47;"</p>
<p>NOTE: It was super tricky to write this explaination, that's why the above is not in a code-block.</p></div>
</div>
<div class="footer">Generated by <a href="http://www.documon.net" target="_blank">Documon</a></div>
</body>
</html>