使用 Sandcastle可以生成MSDN风格的帮助文档，生成的帮助文档既可以是chm文档，也可以是MS Help 2.x帮助文档。
 
 
 
1 下载并安装Sandcastle
 
Sandcastle下载地址为：http://sandcastle.codeplex.com/
 
 
 
2 下载并安装HTML Help Workshop
 
HTML Help Workshop可以用来生成chm文件，有的系统可能已经安装了HTML Help Workshop，HTML Help Workshop的默认安装路径为C:\Program Files (x86)\HTML Help Workshop,安装前可先到此目录下进行确认，若已经安装无须再安装。若需要重新安装最好使用默认安装路径。
 
HTML Help Workshop下载地址为：http://dl.pconline.com.cn/html_2/1/87/id=1917&pn=0.html
 
 
 
3 准备程序集和文档注释文件
 
Sandcastle生成帮助文档是基于代码编译后生成的程序集和文档注释文件来工作的。要想在代码编译过程中能生成文档注释文件，需要在VS中进行如下配置。
 
 
 
设置工程输出时包含XML文档文件，这样就会生成文档注释文件。
 
例：新建工程SandcastleExp，仅包含代码文件Student.cs，编译代码，在bin\Debug目录下的生成的SandcastleExp.dll和SandcastleExp.XML文件就是Sandcastle工具所需要的输入内容。
 

 
 
4 使用命令行方式操作Sandcastle生成帮助文档
 
将步骤3生成的SandcastleExp.dll和SandcastleExp.XML文件拷贝至C:\test文件夹（也可以是其他自建的任意文件夹）,再将C:\Program Files (x86)\Sandcastle\Examples\Sandcastle（Sandcastle安装路径）下的批处理文件build_Sandcastle.bat拷贝至此文件夹。
 
使用cmd打开命令行窗口，进入该目录，输入命令：build_sandcastle.bat vs2005 SandcastleExp chm，回车。
 
成功执行后，会生成如下所示的chm文件。
 

 
 
 注意：第一次安装Sandcastle后需要重启电脑，否则运行build_sandcastle.bat会出错。因为安装Sandcastle 后会创建一个系统环境变量 DXROOT，不重启电脑，该环境变量不会起作用。
 
 
 
3 使用图形用户界面的方式生成帮助文档
 
Sandcastle还提供了图形用户界面供用户操作。可执行文件为C:\Program Files (x86)\Sandcastle\Examples\Generic\SandcastleGui.exe。打开程序，并进行相关设置，界面如下。
 
 
 
点击“Build”后，在C:\Program Files (x86)\Sandcastle\Examples\test\vs2005\chm下生成chm帮助文件。
 
注意：必须使用管理员账户来运行程序。
 
在Win8环境下，需要修改C:\Program Files (x86)\Sandcastle\Examples\Generic\Generic.targets文件，具体修改内容如下：
 
    <When Condition="Exists('$(ProgramFiles) (x86)')">
 
      <PropertyGroup>
 
        <ToolsPath>$(ProgramFiles(x86)) </ToolsPath>
 
      </PropertyGroup>
 
</When>
 
将其中的“$(ProgramFiles(x86)) ”修改为“$(ProgramFiles) (x86) ”（注意：中间还有空格）否则程序无法生成chm文件。
 
 关于代码注释规范，请自行网补。

前言：笔者自己是一位穷逼的个人开发者。自己开发了一款应用，但上架各大手机应用商店基本上都是需要有软件著作权的。现分享一下我申请的全过程，当然网上申请流程已经烂大街都是了，主要分享的是申请资料
 
	申请软件著作权的3种方法
 
自己网上申请，把所需材料递交给国家版权中心（北京的主中心，和3个分局），其余3个城市分局只是代理收资料而已，他们也是邮寄到北京国家版权中心处理的。（该方法办理不需要任何费用）
自己网上申请，把所需材料邮寄到北京国家版权中心（费用是你寄到北京的快递费，北京国家版权中心邮寄回来的快递费需不需要你出这个我就不清楚了）。
通过代理公司办理，但是你经常可以看到说加急多少多少钱，其实版权中心也是有提供这种服务的，不过是额外付费的
 
下图是本人自己去深圳国家版权中心拍的，自己办理免费的啊，31-35那个算加急的，不过自己不加急办理也是差不多35个工作日
 
 
笔者在深圳这边，过去深圳的分部不远，所以选择了第一种。至于第二种邮寄未曾尝试过，请自行百度吧。至于第三种的话，有钱的可以考虑（笔者穷逼一个），办理一张软著大概至少需要300+以上（这个价格是淘宝那种才比较便宜，正规点的约600元起，但是建议别去淘宝，你以后要处理其他事务会比较麻烦），而且软件的使用说明和源代码你不提供的话，还得叫人撰写至少也要100+。还有人家代理公司办理的速度也是和你自己办理的速度一样的。
 
	教程开始
 
http://www.ccopyright.com.cn/ 这个地方注册一下账号
 首页的 我要登记 —> 软件登记
 
 进入个人中心后，在左侧下方的在线业务中选择“我要登记”，然后再选择“R11.计算机软件著作权登记申请”
 
 填写资料可以看看我的
 
 
 
 至于网上填写申请最后一项，按照默认的就可以了，一般交存—>一种文档…例外交存那里不用理会
 
 
 上面只需要填写4处，其他的不用理会
 
当然我讲的不是很详细，要详细的可以考虑去看这篇文章https://blog.csdn.net/cmqwan/article/details/82856206
 当然说说资料，先看看我去版权大厅拍的，当然你看一下参考一下就行了，具体的看下来
 
 上面别太当真，不然你会很乱，你只需要准备下面材料就行了，或者拿我的资料去改改
 
身份证复印件
说明书一份16+张(我自己写了24张，这玩意你看我附件就知道了，很容易的)
软件著作权申请表一份4张（就是你刚才在网上填写的申请表，打印出来就行了，好像第四张要签名。注意这里有一个坑，看下面）
源程序一份61张（这种直接那我的资料，然后把第一页的软件名称改掉，和每一页的页头的软件名称改掉就可以了）
 
4张申请表的注意事项
 每一页的页头最上面必须是流水号（条纹码），因为他的打印真的很怪，打印出来出现下面这张的错误情况
 
 
上面是错误的，下面才是正确的，4张每一张的流水号都在最上面（每一张的最上面只能是流水号，不能出现上一页的内容），而且底下不能出现下一页的内容
 
 
 
 
我申请的流程状态
 
 

 12月30号那天办理的，然后到现在2月24号拿到手，一共两个月24天，而且快递也慢（应该也是疫情影响的），不然更快。整体还算满意吧，毕竟新年，元宵，还有疫情影响都不知道他们休了多少天。
 给你们大概看一些源代码资料和软件说明资料的截图
 
 
 
软件使用说明的大致截图
 
 

 
 
 
 
 
 
源代码截图
 
 

 例外，文件原本是我取用https://blog.csdn.net/cmqwan/article/details/82856206该链接里面的提供素材进行修改的，也感谢原作者 cmqwan
 
文档下载地【免费】https://download.csdn.net/download/qq_23064433/12188550
 链接：https://pan.baidu.com/s/1oR7FhSJtME1xhrYKrAEGaA
 提取码：y70o
 
本人邮箱，真有需要的可以发来问问，但别骚扰我 2309680188@qq.com
 

 上图是我传递之后的所有状态，你们可以参考一下，2月13号过后不久我就收到快递了
 
2020/07/03 更新说明
 如果有公司建议使用软著著作权人为公司的，要不然在以后上架到应用商店时，如果你的应用商店认证是你的公司，但是软著著作权人又是个人的话，有些应用商店还有要求你写一个公司和著作权人的授权说明书，至于公司的怎么申请，可以去翻翻下面的评论
 2020/10/16 更新说明
 去分局的话是需要预约的，在微信公众号里面预约，《中国版权服务》底部导航->微平台->后续操作我就记不清了。
 
另外说明，该文章很有可能会被其他网站转载，导致你找不到评论，原贴在csdn（根据标题搜索）

用法
 
 

  

       <link rel="stylesheet" href="../../assets/highlight/styles/default.css">
  
  

       <script type="text/javascript" charset="UTF-8" src="../../assets/highlight/highlight.pack.js"></script>
  
 
 
API
 
 暴露出来的方法都放在hljs对象中
 
highlight(name, value, ignore_illegals, continuation)
 用指定的语言高亮代码块
 参数： 
   

    

       name：语言名称
    
    

       value：原始HTML字符串
    
    

       ignore_illegals：是否忽略非法字符
    
    

       continuation：是否继续未完成的解析
    
   
 
 
 返回值：Object
 language: 指定的语言，和输入的一致
 relevance: 整数值
 value: 处理后的高丽HTML字符串
 top: top of the current mode stack
 
highlightAuto(value, languageSubset)
 自动高亮指定语言中的代码块
 参数： 
   

    

       value：html标签
    
    

       languageSubset：语言数组
    
   
 返回值：Object 
   

    

       language: 检测到的语言
    
    

       relevance: 整数值
    
    

       value: 被高亮的HTML标记
    
    

       second_best: 检车到的第二语言，有可能为空
    
   
 
 
 
fixMarkup(value)
 后处理高亮的标记，比如替换TAB，<br>等，配置项是在configure中设置的
 
 
highlightBlock(block)
 应用高亮到一个包含代码的DOM节点上
 
 
configure(options)
 全局配置
 tabReplace: 用来替换TAB字符串的字符
 useBR: 一个开关选项，用来生成<br>代替新一行的字符，当代码使用非<pre>包裹时很有用
 classPrefix: 一个加载类名前面的字符串标记，为了兼容样式表
 languages: 语言名称或别名的数组，对于这些语言使用自动检测
 
   

    

       hljs.configure({
    
    

         tabReplace: '    ', // 4 spaces
    
    

         classPrefix: ''      // don't append class prefix
    
    

                                    // … other options aren't changed
    
    

       })
    
    

       hljs.initHighlighting();
    
   
 
 
initHighlighting()
 在页面的<pre><code>..</code></pre>区域上应用高亮
 
 
initHighlightingOnLoad()
 绑定高亮到页面加载事件上
 
 
registerLanguage(name, language)
 增加一种支持语言，绝大部分情况下内部使用
 name：被支持语言的名称
 language支持语言的函数
 
 
listLanguages()
 返回语言名称列表
 
 
getLanguage(name)
 通过名称或者匿名查找语言，返回一个object对象，否则返回null
 
 
参考资料
 
http://highlightjs.readthedocs.org/en/latest/api.html

java代码规范文档
 
原则：
 
注释形式统一
 
在整个应用程序中，使用具有一致的标点和结构的样式来构造注释。如果在其它项目中发现它们的注释规范与这份文档不同，按照这份规范写代码，不要试图在既成的规范系统中引入新的规范。
 
注释内容准确简洁
 
内容要简单、明了、含义准确，防止注释的多义性，错误的注释不但无益反而有害。
 
注释条件
 
基本注释
 
1.类（接口）的注释
 2.构造函数的注释
 3.方法的注释
 4.全局变量的注释
 5.字段/属性的注释
 
特殊必加注释
 
1.典型算法必须有注释
 2.在代码不明晰处必须有注释
 3.在代码修改处加上修改标识注释
 4.在循环和逻辑分支组成的代码中加注释
 5.为他人提供的接口必须加详细注释
 
注释格式
 
单行(single-line)注释：“//……”
 块(block)注释：“/……/”
 文档注释：“/*……/”
 javadoc 注释标签语法
 
@author   对类的说明 标明开发该类模块的作者 
@version   对类的说明 标明该类模块的版本 
@see     对类、属性、方法的说明 参考转向，也就是相关主题 
@param    对方法的说明 对方法中某参数的说明 
@return   对方法的说明 对方法返回值的说明 
@exception  对方法的说明 对方法可能抛出的异常进行说明
 
参考实例
 
类（接口）的注释
 
/**
 * @Description 类的描述
 * @author Administrator
 * @Time 2018-09-28
 * @version v1.1
 */
public class testEwallet {
	
}
 
构造函数的注释
 
    /**
	 * @Description 构造方法描述
	 * @param name
	 * 按钮上显示文字
	 */
	public testEwallet(String name){
	}
 
方法注释
 
 /**

        * 为按钮添加颜色

        * @param color

        * 按钮的颜色

        * @return 

        * @exception  (方法有异常的话加)

        * @author Administrator

        * @Time2012-11-20 15:02:29

        */

        public voidaddColor(String color){
        }
 
全局变量注释
 
  /** The value is used for characterstorage. */

     private final char value[];
 
字段/属性注释
 

     private String senderName;//发送人姓名

     private String title;//不能超过120个中文字符