pycharm一件注释

### 在 PyCharm 中使用快捷方式一键添加注释

#### 行注释
对于行注释，在 PyCharm 中可以通过按下 `Ctrl + /` 来实现单行或多行的快速注释或取消注释。当希望对某一行代码加上注释时，只需将光标放置于该行任意位置并按此组合键；若要批量处理多行，则先选中目标区域再执行相同操作即可[^1]。

#### 块注释
针对大段落或者特定范围内的代码块进行整体性的注解工作，可以采用块注释的方式。具体做法是在选定待注释部分之后利用 `Ctrl + Shift + /` 完成包裹式的注释添加。这种方式适用于那些需要被临时屏蔽掉但仍保留其结构逻辑的内容片段。

#### 函数注释模板配置
为了方便开发者更为便捷地为函数添加详细的描述信息，PyCharm 提供了一个专门的功能——自定义函数注释模板。进入设置界面 (`File -> Settings`) 后找到 `Tools -> Python Integrated Tools` ，在这里可以根据个人需求调整生成新函数时默认附带的注释样式[^4]。

def example_function(arg1, arg2):
    """
    Brief summary of what the function does.

    :param arg1: Description of argument one.
    :type arg1: Type information for first parameter.
    
    :param arg2: Explanation about second input value.
    :type arg2: Data type expected by this paramter.

    :return: What will be returned after execution?
    :rtype: Return object's data type specification here.
    """
    pass