各种代码文件中的注释格式

最新推荐文章于 2024-06-25 22:00:00 发布
最新推荐文章于 2024-06-25 22:00:00 发布
阅读量505 收藏 1
点赞数
原文链接：http://www.cnblogs.com/olmlo/archive/2013/05/29/3105274.html
版权

1、freemarker

    <#--注释内容-->  不会输出到页面源码中

2、 Velocity

    多行注释 #* 注释内容 *#
    单行注释 ## 注释内容

3、JSP注释

    <%-- 注释内容 --%>

4、html注释

    <!--注释内容-->

5、CSS注释

    /* 注释内容 */

6、JavaScript注释

    单行注释  //注释内容

    多行注释 /* 注释内容*/

   

 
 
 
 

 

转载于:https://www.cnblogs.com/olmlo/archive/2013/05/29/3105274.html

                

        

        




    

  


    

      

        

            

              
                
                  weixin_34221773
                
              
            

            

                关注
              
            

        

        

          
      

      









                



	

		

			

				
					
代码注释格式设置

				
			

			

				

					10-23
				

			

		

		

			
				
代码注释格式设置,规范开发代码。有助开发人员查看代码

			
		

	



                

              
                



	

		

			

				
					
代码注释的格式

				
			

			

				

					孙启超
				

				

					08-23
					
					9515
					
				

			

		

		

			
				
一直感觉注释很重要，所以把注释的一些规范总结一下，对后期维护真是非常的重要。
1.先写一下个个字段对应的意思
/*!
 @header     文件名
 @abstract   简介，概念
 @discussion 用途，方法
 @copyright  版权
 */
给出一个模版

/*!
 @header     MFMailComposeViewController

			
		

	



                


  
              

                


	

		

			

				
					
前端：HTML、CSS、JavaScript 代码注释 / 注释与代码规范

					
最新发布

				
			

			

				

					snowball的博客
				

				

					06-25
					
					4358
					
				

			

		

		

			
				
HTML注释是在HTML代码中添加说明和解释的一种方法，这些注释不会被浏览器渲染或显示在页面上，而是被浏览器忽略。使用单行注释或多行注释：对于较短的注释，可以使用单行注释；对于较长的注释或需要跨越多行的注释，应使用多行注释。使用有意义的注释：确保注释提供了有价值的信息，而不是简单的“TODO”或“此处需要修改”。结束来标记多行注释。位于被注释的代码附近：通常，注释应位于被注释的代码之前或之上，以便于阅读和理解。位于被注释的代码之前：通常，注释应位于被注释的代码之前，以便于阅读和理解。

			
		

	





	

		

			

				
					
我的代码文件注释格式

				
			

			

				

					cay22的专栏
				

				

					04-02
					
					1663
					
				

			

		

		

			
				
我的代码文件注释格式

			
		

	



		

			
		



	

		

			

				
					
代码添加注释规范

				
			

			

				

					weixin_34416649的博客
				

				

					07-01
					
					233
					
				

			

		

		

			
				
　　没有注释的代码就是一坨屎，又烂又臭。
　　在写代码时就应该添加注释，这时在你的脑子里的是清晰完整的思路。
　如果在代码最后再添加注释，它将花费你双倍的时间。
　　1、对每个类添加注释：包括摘要信息，作者信息，最近修改日期等；


//  AppReviewAlertView.h//  iSuzhouCity////  Created by Chen Nan on 5/24/11./...

			
		

	





	

		

			

				
					
keil插件包(格式化代码 文件注释 函数注释 当前日期 当前时间)

				
			

			

				

					02-07
				

			

		

		

			
				
同时，对于文件注释的添加，Astyle也能提供帮助，虽然它可能需要配合其他工具或自定义脚本来实现。至于插入当前日期和时间，这通常需要通过编写自定义宏或利用Keil自身的预处理器功能来实现，而不是直接通过Astyle...

			
		

	





	

		

			

				
					
keil插件包（格式化代码 文件注释 函数注释 当前日期 当前时间）

				
			

			

				

					10-29
				

			

		

		

			
				
keil插件包，导入这些插件实现（格式化代码 文件注释 函数注释 当前日期 当前时间）等功能，更加方便嵌入式开发。使用教程：https://blog.csdn.net/qq_44078824/article/details/109349611

			
		

	





	

		

			

				
					
eclipse代码编码和注释格式xml文件

				
			

			

				

					10-15
				

			

		

		

			
				
eclipse注释模板

			
		

	





	

		

			

				
					
PE文件各种操作源代码加注释

				
			

			

				

					09-28
				

			

		

		

			
				
PE文件，PE文件各种操作的源代码，方法，包含大量注释，文件操作

			
		

	





	

		

			

				
					
Java代码、注释模版格式文件

				
			

			

				

					04-12
				

			

		

		

			
				
文件列表中的"代码"和"注释模版"可能分别代表了实际的代码示例和注释的格式模板。开发者可以根据这些模板来编写自己的Java代码，确保其符合既定的规范。  在实际开发中，遵循这样的模板和规范是非常有益的。它可以...

			
		

	





	

		

			

				
					
code-checker:这是一个代码检查器，可以识别程序文件中的不同类型的注释

				
			

			

				

					03-29
				

			

		

		

			
				
代码检查器
这是一个代码检查器，可以识别程序文件中的不同类型的注释
该代码检查器是一个原型，您可以做一些事情来扩展其功能或满足特定的要求并将其安装到系统中。
 该程序默认从stdin读取，您可以通过运行以下命令来使用它：“ ./ checker <[programfile]”； 但是，您可以通过对“ main”函数（构造函数的参数）进行细微更改来将输入绑定到其他源。
 该程序默认将输出发送到stdout，您可以通过对“ main”函数（构造函数的参数）进行细微更改将输出重定向到其他地方。
 该程序默认情况下使用C / C ++文件，您可以通过对“ main”函数（调用“ loadLanguage（vector list）函数”）进行细微更改来更改lanaguage支持。 已经设置了支持Python和Java的语言。

			
		

	





	

		

			

				
					
代码注释格式说明

				
			

			

				

					cay22的专栏
				

				

					03-31
					
					1677
					
				

			

		

		

			
				
// 文件头说明格式/************************************************************************* copyright (c) 2004, *****公司* all rights reserved.* * 文件名称：**.h 或者 **.** 摘    要：对该代码文件要做些什么或者说该模块要做些什么

			
		

	





	

		

			

				
					
代码注释该怎么写才规范？

				
			

			

				

					strongerHuang
				

				

					04-24
					
					734
					
				

			

		

		

			
				
关注+星标公众号，不错过精彩内容编排 |strongerHuang微信公众号 |strongerHuang如果领导给你一个项目的源码让你阅读，并理解重构代码，但里面一句注释都没有，我想这肯定是之前同事“删库跑路”了。看一份源码什么很重要？除了各种代码规范之外，还有一个比较重要的就是注释。注释虽然写起来很痛苦, 但对保证代码可读性至关重要，下面的将描述如何注释以及在哪儿注释。注释风格1.总述一般...

			
		

	





	

		

			

				
					
Python 为什么用 # 号作注释符？

				
			

			

				

					Python猫
				

				

					07-19
					
					676
					
				

			

		

		

			
				
????“Python猫” ，一个值得加星标的公众号关于编程语言中的注释，其重要性基本上已为大家所共识。然而关于注释的规范，这个话题就像我们之前聊过的缩进、终止符和命名方式一样，众口难...

			
		

	





	

		

			

				
					
代码注释的三种方式

				
			

			

				

					qq_47248941的博客
				

				

					07-28
					
					1995
					
				

			

		

		

			
				
Java注释
对所写的程序进行解释说明
Java的三种注释方式
单行注释
//后面的内容为注释
多行注释
/*
其中内容为注释
*/
在java进行编译时单行注释与多行注释不被编译
文档注释(java特有)
格式：/**
@author  指定java程序的作者
@version  指定源文件的版本
*/
注释内容可以被JDK提供的工具 javadoc 所解析，生成一套以网页文件形式体现的该程序的说明文档(类似API文档)。
操作方式：
javadoc -d 新文件名 -aouhor -version 被编

			
		

	





	

		

			

				
					
PHP代码添加注释的几种格式

				
			

			

				

					x163326的专栏
				

				

					07-02
					
					1133
					
				

			

		

		

			
				
PHP代码添加注释的几种格式:
1、用 // 开头，作为单行注释。例如：

    // Author: mole
    // Date:2012-2-8
    echo "Welcome!";
?>
2、用 # 开头，作为单行注释。例如：

    # Author: mole
    # Date:2012-2-8
    echo "Welcome!";
?>


			
		

	





	

		

			

				
					
Java代码注释和编码规范

				
			

			

				

					小呆苗的博客
				

				

					09-16
					
					846
					
				

			

		

		

			
				
Java代码注释和编码规范

			
		

	





	

		

			

				
					
C/C++ 程序员编程规范之注释（参考）

				
			

			

				

					探索C++编程的奥秘，分享深入的技术见解和实践，旨在激发读者创造力与解决问题的思维。
				

				

					02-05
					
					4449
					
				

			

		

		

			
				
编程规范(注释)



注释的原则是有助于对程序的阅读理解，在该加的地方都加了，注释不宜太多也不能太少，注释语言必须准确、易懂、简洁。


说明性文件（如头文件.h文件、.inc文件、.def文件、编译说明文件.cfg等）头部应进行注释.


  注释适当列出：版权说明、版本号、生成日期、作者、内容、功能、与其它文件的关系、修改日志等，头文件的注释中还应有函数功能简要说明。




源文件头部也应进行注释.


  列出：版权说明、版本号、生成日期、作者、模块目的/功能、主要函数及其功能、修...

			
		

	





	

		

			

				
					
代码中.txt文件如何注释

				
			

			

				

					05-11
				

			

		

		

			
				
在代码中，如果要注释一个.txt文件中的内容，可以使用以下两种方法：

1. 在每行前面加上一个“#”符号，表示这一行是注释，不会被程序执行。

例如：

```
# 这是一段注释
Hello world!
```

2. 使用多行注释符号“'''”或“"""”将注释内容括起来，其中“'''”或“"""”可以连续三个或更多。

例如：

```
"""
这是一段多行注释，
可以跨越多行。
"""
```

上述方法中，第一种方法适用于单行注释，第二种方法适用于多行注释。请根据实际需求选择合适的方法。

			
		

	



              




          




        



    





    



      

      

        
      

      





	

		评论	
	

	
	




  

    

      添加红包
      
    

    

      

        
        

          
          
        

        
请填写红包祝福语或标题

      

      

        
        

          
          个
        

        
红包个数最小为10个

      

      

        
        

          
          元
        

        
红包金额最低5元

      

      

        
        

          当前余额3.43元
          前往充值 >
        

      

      

        

          需支付：10.00元
        

        
        
      

    

  





  

    
    
  

  

    
    
  








  

    

      

        

          

            
            
成就一亿技术人!

          

          

        

        

          

          

            领取后你会自动成为博主和红包主的粉丝
            规则
          

        

      

      

        

          

            
              
            
            

              
hope_wisdom
 发出的红包
            

          

        

        

          

          

          

        

      

    

    

  



      
      

      
实付元

      
使用余额支付

      

        

          

            
            点击重新获取
          

        

        
扫码支付

      

      

        
          
            
          
          
        
      

      

        
        钱包余额
          0
          

            
            

              

                
抵扣说明：

                
 1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
 2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

              

            

          

      

      余额充值