目 录 1.序言4 2.范围4 3.代码命名的一般原则4 4.代码注释的一般原则和类型4 5.方法命名和注释规范6 5.1.成员方法的命名6 5.2.构造方法的命名6 5.3.成员方法的头部注释文档规范6 5.4.成员...
分类:
其他好文 时间:
2015-05-14 11:43:29
阅读次数:
317
1,基本标签
:html文档的根元素,可以指定一个xmlns属性,值只能是http://www/w3.org/1999/xhtml。
:页面主体部分
:页面开始部分
:CSS定义
到:定义标题一到标题六。数字越大,显示的标题越小
:段落
:换行
:水平线
:注释
:文档中的节
:也是文档中的节
ok,html的常用标签就是上面这些,有3个标签经常用到,他们都可以作为...
分类:
Web程序 时间:
2015-04-29 17:10:29
阅读次数:
167
目前源码和文档一般都是分开的,我在想为什么 源码不就是最好的文档么?但是一般源码都是文本text的,格式化需要人为统一规范,所以源码中的文档在现实中不是那么的易于实践。而且 源码 不能包括图片、附件、示例代码等资源,这个又是一个难点。后来我突发奇想,为什么不能把xml作为一种合二为一的文档呢?xml...
分类:
其他好文 时间:
2015-04-14 19:41:17
阅读次数:
133
第一步:将jar加入到Referenced Libraries 右键点击jar --> 选择 Build Path --> Add to Build Path 第二步,设置jar的java doc 右键点击Referenced Libraries下的jar --> 选择 Build Path -->...
分类:
编程语言 时间:
2015-04-08 10:45:27
阅读次数:
169
文档注释,无非“//”和“/**/”两种 ,自己写代码,就那么点,适当写几句就好了;但是一个人总有融入团队的一天,团队的交流不是那几句注释和一张嘴能解决的,还需要通用的注释标准。PHPDoc是PHP文档注释的一个标准,可以帮助我们在注释文档时有规范,查看别人的代码时更方便。下面的表格是我翻译的WIK...
分类:
Web程序 时间:
2015-03-30 22:23:24
阅读次数:
157
参考链接:
1. Appledoc 生成xcode 注释文档
2. https://github.com/tomaz/appledoc
3. Objective-规范注释心得
4. 使用Objective-C的文档生成工具:appledoc
5. http://www.simplicate.info/2013/07/25/using-appledoc-to-generate-xcode-h...
分类:
移动开发 时间:
2015-03-11 14:47:29
阅读次数:
166
软件实现:程序设计语言一直在不断地演化和演变,其发展经历了从机器语言到高级语言的过程。软件编程规范:文件命名和组织;代码的版式(适当的空行、代码行及行内空格);分行、对齐与缩进、命名规则(通用规则、其他规则);声明;注释(文档风格,C语言风格,当行注释)。软件编程案例分析:程序注释问题,变量命名问题...
分类:
其他好文 时间:
2015-03-01 13:06:28
阅读次数:
111
一、代码注释1、文档型注释该类注释采用.Net已定义好的Xml标签来标记,在声明接口、类、方法、属性、字段都应该使用该类注释,以便代码完成后直接生成代码文档,让别人更好的了解代码的实现和接口。【示例】如 ///MyMethod is a method in the MyClass class.///...
注释不是给编译器看的,而是给程序员看的。是程序员之间交流的一种方式。好的程序员一定要有完善的注释。 .NET注释类型。 1.单行注释 // a.当代码行比较短时,注释可以放在代码后面。 b.当代码行比较长时,注释一定要放在注释代码上边,而不是下边。 c.快捷键:选中要注释的代码, 注释: ctrl ...
分类:
Web程序 时间:
2014-12-25 00:09:58
阅读次数:
158
原文:GhostDoc的使用 一、简介 GhostDoc是Visual Studio的一个免费插件,可以为开发人员自动生成XML格式的注释文档。 二、下载 需要的朋友可以去这里下载,填个Email地址就可以下了:GhostDoc下载地址 三、安装 下载安装完成后,可以在Visual Studio的工...
分类:
其他好文 时间:
2014-12-16 11:18:19
阅读次数:
119