如何快速地注释python代码注释规范

100526人阅读
ASP.NET(18)
最近在使用VS2010开发ASP.Net,突然发现想全部注释时找不到注释的快捷键,网上查了下,原来很简单,只是需要使用组合键。
注释: & & & &先CTRL+K,然后CTRL+C
取消注释:&先CTRL+K,然后CTRL+U
参考知识库
* 以上用户言论只代表其个人观点,不代表CSDN网站的观点或立场
访问:418752次
积分:3837
积分:3837
排名:第7087名
原创:49篇
转载:63篇
评论:41条
(2)(2)(5)(3)(3)(2)(8)(10)(6)(5)(7)(14)(4)(4)(1)(2)(3)(3)(7)(5)(1)(15)您所在的位置: &
进行CSS注释的三种方法
进行CSS注释的三种方法
就像HTML教程中描述的一样,在CSS文档中CSS注释也起到很重要的作用,可以帮助我们记起CSS的含义,加载在HTML文档的位置等,并且CSS注释的开始使用/*,结束使用*/。
通常注释代码如果是单行注释的话开始使用/*,结束使用*/,这里向大家描述一下CSS代码中进行注释的三种方法,相信本文介绍一定会让你有所收获。
CSS代码中进行注释的三种方法
1、选择器(childselector)
如果你想在IE中隐藏一个CSS定义,可以使用子选择器。
CSS注释代码:
htmlbodyp{ &/*declarations*/ &} &&
2、&通配符&(*)
这种写法只有IE浏览器可以理解(对其他浏览器都隐藏)
CSS注释代码:
*htmlp{ &/*declarations*/ &} &&
3、&反斜线&(\)
如果你希望IE/Win有效而IE/Mac隐藏,可以使用&反斜线&技巧。
CSS注释代码:
/*\*/ &*htmlp{ &declarations &} &/**/ &
【编辑推荐】
【责任编辑: TEL:(010)】
关于的更多文章
Angular.js 是一个MV*(Model-View-Whatever,不管是MVC或者MVVM
随着云计算、物联网、大数据、移动互联网的大发展,你应该知道这些。
又到了一周的末尾,闷热过后,这周的温度算是降下来了
掌握一门技术,首要的是掌握其基础。笔者从事.NET相关
再过十几天很多同学又要爬楼梯睡觉,早上七点起床,晚
本书作为思科认证体系中的入门级教材,主要讲述了网络的基本知识和思科设备的基本命令,以及路由、交换等深层次网络知识的入门知
51CTO旗下网站Python代码注释应该怎么写? - 推酷
Python代码注释应该怎么写?
写代码注释是一件很重要的事情,如果你写的一段函数给别人调用那么往往都需要配上一些基本的注释。写好代码可以让别人容易阅读你的代码。试想一下:如果你在github上面找到一段你想要的代码,这段代码有200行,可能这些代码我们要进行改造,那么这时候如果代码中都没有恰当的注释,我们可能要用比较久的时间去通读一下他的代码。
相反,如果这些代码有一些恰当的注释,我们可能会更加好理解一点。学会注释是编码过程中不可或缺的一部分。那么什么样的注释才是规范的注释,才能让其他看你代码的人能快速的了解你得代码结构呢。我们今天就说一说 有关于Python的一些注释规范。
在说规范之前我们有必要先看以下Python的注释有哪些?
按照每一个注释进行简单的介绍(我们截选request库的一段文件):
第一行第二行:为上述所说的特殊注释,这两个注释也几乎是在你所编写的每一个py文件中应该存在的,正常情况下第一第二行通用格式。
关于 #!/usr/bin/env python
1、必须是文件的第一行
2、必须以#!开头
3、#!/usr/bin/env python告诉LINUX/UNIX去找到python的翻译器。
关于: # -*- coding: utf-8 -*-
1、基本上在文件的第二行,在#!/usr/bin/env python的下一行
2、python interpret如何解释字符串的编码
3、当你的文件中出现中文的时候,你必须使用它
第四到第十三行:为上述所说的所行注释。多行注释,以三个引号开始,三个引号结尾。这三个引号可以使单引号也可以是双引号。
1、一般类文档,函数文档,字符串之类的用双引号,变量用单引号。
第二十一行:我们所说的单行注释,单行注释以#开头标识。
你也可以连续多次使用#单行注释来代替多行注释,但是我们并不推荐那么做。
知道了上述的注释之后,我们需要知道的是在哪些场合使用哪些注释。
第一点:为了避免麻烦,在文件的开头加上这两句。
#!/usr/bin/env python
# -*- coding: utf-8 -*
第二点:每一个Python文件的开头,紧接着第一点所说的两行代码之后,我们往往要写上关于这个模块即这个Python文件实现的功能一些注意点,可能会发生的错误,总之你得注释要让使用它的人很明白你得代码段,比如:
requests.cookies
~~~~~~~~~~~~~~~~
Compatibility code to be able to use `cookielib.CookieJar` with requests.
requests.utils imports from here, so be careful with imports.
This is the Scrapy engine which controls the Scheduler, Downloader and Spiders.
For more information see docs/topics/architecture.rst
可能,你不看代码,都已经知道接下来的是什么了,那么你能找到上面这个注释是出自哪个文件吗?
第三点:每一个类下面加上关于这个类的说明以及用法,这样使用它的人可能都不要知道他的内部构造,就可以使用他了,我们看看这个。
第一:这个类是干嘛的?
第二:经常在什么情况下使用?
第三:如何使用?
都交待说明的很详细,你不看代码估计已经会使用了。
class HTTPAdapter(BaseAdapter):
&&&The built-in HTTP Adapter for urllib3.
Provides a general-case interface for Requests sessions to contact HTTP and
HTTPS urls by implementing the Transport Adapter interface. This class will
usually be created by the :class:`Session &Session&` class under the
:param pool_connections: The number of urllib3 connection pools to cache.
:param pool_maxsize: The maximum number of connections to save in the pool.
:param max_retries: The maximum number of retries each connection
should attempt. Note, this applies only to failed DNS lookups, socket
connections and connection timeouts, never to requests where data has
made it to the server. By default, Requests does not retry failed
connections. If you need granular control over the conditions under
which we retry a request, import urllib3's ``Retry`` class and pass
that instead.
:param pool_block: Whether the connection pool should block for connections.
&&& import requests
&&& s = requests.Session()
&&& a = requests.adapters.HTTPAdapter(max_retries=3)
&&& s.mount('http://', a)
第四点:每一个函数下面务必加上多行注释,很有可能你的函数注释只有一行,或者两行,你可以使用单行注释,也可以使用多行注释,这里与类函数说明相当,注释中往往包含使用说明,注意点。
def __setstate__(self, state):
# Can't handle by adding 'proxy_manager' to self.__attrs__ because
# self.poolmanager uses a lambda function, which isn't pickleable.
def has_capacity(self):
&&&Does the engine have capacity to handle more spiders&&&
return not bool(self.slot)
第五点:在必要的地方加上单行注释。这些地方不外乎
1、你不怎么理解的代码
2、别人可能不理解的代码
3、提醒自己或者别人注意的代码、重要代码
self.inprogress = set() # requests in progress
assert not self.running, &Engine already running&
以上,更多的编码习惯。你可以去读一读,request的代码。
同时你也可以去看看这个(Google的开源风格):
是一个高质量的技术社区,从 Swift 到 React Native,性能优化到开源类库,让你不错过把互联网开发的每一个技术干货。当然你可以选择下载他们的app:点击
或者各大应用市场搜索「掘金」,技术干货尽在掌握中。赶紧去看看吧。
已发表评论数()
请填写推刊名
描述不能大于100个字符!
权限设置: 公开
仅自己可见
正文不准确
标题不准确
排版有问题
主题不准确
没有分页内容
图片无法显示
视频无法显示
与原文不一致python快速生成注释文档的方法
&今天将告诉大家一个简单平时只要注意的小细节,就可以轻松生成注释文档,也可以检查我们写的类方法引用名称是否重复有问题等。一看别人专业的大牛们写的文档多牛多羡慕,不用担心我们可以让python为我们生成基本满足的说明文档,一来可以提高代码整体阅读性,二来可以将代码的整体结构看着也更清晰,这样在交接的时候可以省很多麻烦,其它同事在接手你工作的时候也不会一行行去问你这是什么那是什么的,因为注释已经很直观的表述了,在整合的时候可当说明文档给客户简单说明(主要是给你BOSS看的),那么进入正题怎么实现看下面我简单的代码格式,注意注释的地方和函数名类名都是与__all__内相关联的
#!/usr/bin/env python
# -*-coding:utf-8 -*-
文档快速生成注释的方法介绍,首先我们要用到__all__属性
在Py中使用为导出__all__中的所有类、函数、变量成员等
在模块使用__all__属性可避免相互引用时命名冲突
__all__ = ['Login', 'check', 'Shop', 'upDateIt', 'findIt', 'deleteIt', 'createIt']
class Login:
测试注释一可以写上此类的作用说明等
例如此方法用来写登录
def __init__(self):
初始化你要的参数说明
那么登录可能要用到
用户名username
密码password
def check(self):
协商你要实现的功能说明
功能也有很多例如验证
判断语句,验证码之类的
class Shop:
商品类所包含的属性及方法
update改/更新
delete删除
create添加
def __init__(self):
初始化商品的价格、日期、分类等
def upDateIt(self):
用来更新商品信息
def findIt(self):
查找商品信息
def deleteIt(self):
删除过期下架商品信息
def createIt(self):
创建新商品及上架信息
if __name__=="__main__":
import pythonzhushi
print help(pythonzhushi)
这里要强调说明下py的名字要和你当前工作的py名字一样(我这里创建的py名字就是pythonzhushi,最后导入也是这名字),因为下面的测试中import的导入的是自身所以,import 名称 和Help(名称)以及你的文件名称要一致才可以。为了更加直观请看下面这图:
当然还可以从其它文件引用的方式导入这里用到python常用的导入方式from从哪个目录import导入什么文件pythonzhushi
当然我这里还是用图片来展示以下:
是不是一目了然,这样也可以导入我们需要做的注释文档,help帮助方法就是帮我们查看到此文件中所包含的类,函数,的一个简单帮助文档,类似于readme文档的一个说明。最后来看看掩饰效果吧:
是不是简单的打印出我们程序的说明文档,后面步骤直接可以建一个文本把这个粘贴过去,就完成一个readme的文档说明,经过测试有几点注意是,想要写#这种注释不要写到def放发内要写到它的上面位置和装饰器类似,相反三引号'''不要写到def外面,这样也是没显示效果的。大家赶紧去试试吧。感谢观看。。
阅读(...) 评论()}

我要回帖

更多关于 python代码注释规范 的文章

更多推荐

版权声明:文章内容来源于网络,版权归原作者所有,如有侵权请点击这里与我们联系,我们将及时删除。

点击添加站长微信